void |
Environment.addRegionDeployment(Region region) |
Add a deployment to the specified region.
|
void |
PipelineExecution.advance() |
Advance this execution, if in a valid state.
|
void |
PipelineExecutionApi.advance(@NotNull PipelineExecution execution) |
Advance the execution of the specified pipeline execution, if in an appropriate state.
|
void |
PipelineExecutionApi.advance(@NotNull String programId,
@NotNull String pipelineId,
@NotNull String executionId) |
Advance the execution of the specified pipeline execution, if in an appropriate state.
|
A |
ApiBuilder.build() |
Build a new instance of the requested API.
|
void |
ContentFlow.cancel() |
Cancel this content flow.
|
void |
PipelineExecution.cancel() |
Cancel this execution, if in a valid state.
|
void |
PipelineExecutionApi.cancel(@NotNull PipelineExecution execution) |
Cancel the execution of the specified pipeline execution, if in an appropriate state.
|
void |
PipelineExecutionApi.cancel(@NotNull String programId,
@NotNull String pipelineId,
@NotNull String executionId) |
Cancel the execution of the specified pipeline execution, if in an appropriate state.
|
@NotNull ContentFlow |
ContentSetApi.cancelFlow(@NotNull String programId,
@NotNull String id) |
Cancel the content flow.
|
@NotNull ContentSet |
ContentSetApi.create(@NotNull String programId,
@NotNull String name,
String description,
@NotNull Collection<ContentSet.PathDefinition> definitions) |
Create a new ContentSet in the specified program.
|
@NotNull Environment |
EnvironmentApi.create(@NotNull String programId,
@NotNull String name,
Environment.Type type,
@NotNull String region,
String description) |
Create a new environment in the program.
|
void |
EnvironmentApi.createRegionDeployments(@NotNull Environment environment,
@NotNull Region... regions) |
Create a new deployment in the specified region.
|
void |
ContentSet.delete() |
Delete this content set definition.
|
void |
ContentSetApi.delete(@NotNull String programId,
@NotNull String id) |
Delete the content set.
|
void |
Environment.delete() |
Delete this environment.
|
void |
Environment.delete(boolean ignoreFailure) |
Delete this environment, with option to ignore resource deletion failure.
|
void |
EnvironmentApi.delete(@NotNull Environment environment) |
Delete the environment.
|
void |
EnvironmentApi.delete(@NotNull Environment environment,
boolean ignoreFailure) |
Delete the environment.
|
void |
EnvironmentApi.delete(@NotNull String programId,
@NotNull String environmentId) |
Delete the environment in the specified program.
|
void |
EnvironmentApi.delete(@NotNull String programId,
@NotNull String environmentId,
boolean ignoreFailure) |
Delete the environment, with option to ignore resource deletion failure.
|
void |
Pipeline.delete() |
Delete this pipeline.
|
void |
PipelineApi.delete(@NotNull Pipeline pipeline) |
Delete the pipeline.
|
void |
PipelineApi.delete(@NotNull String programId,
@NotNull String pipelineId) |
Delete the pipeline.
|
void |
Program.delete() |
Delete this program.
|
void |
ProgramApi.delete(@NotNull Program program) |
Delete the program.
|
void |
ProgramApi.delete(@NotNull String programId) |
Delete the program.
|
Collection<EnvironmentLog> |
Environment.downloadLogs(LogOption logOption,
int days,
File dir) |
Download the logs for this environment, to the specified directory.
|
@NotNull Collection<EnvironmentLog> |
EnvironmentApi.downloadLogs(@NotNull Environment environment,
@NotNull LogOption logOption,
int days,
@NotNull File dir) |
Downloads the logs for the environment, to the specified folder.
|
@NotNull Collection<EnvironmentLog> |
EnvironmentApi.downloadLogs(@NotNull String programId,
@NotNull String environmentId,
@NotNull LogOption logOption,
int days,
@NotNull File dir) |
Downloads the logs for the environment, to the specified folder.
|
@NotNull ContentSet |
ContentSetApi.get(@NotNull String programId,
@NotNull String id) |
Get the content set.
|
Environment |
EnvironmentApi.get(@NotNull String programId,
@NotNull String environmentId) |
Retrieve the environment within the program context.
|
Optional<Environment> |
EnvironmentApi.get(@NotNull String programId,
@NotNull Predicate<Environment> predicate) |
Returns the first environment which matches the predicate, within the program context.
|
@NotNull Pipeline |
PipelineApi.get(@NotNull String programId,
String pipelineId) |
Get the pipeline within the specified program.
|
@NotNull PipelineExecution |
PipelineExecutionApi.get(@NotNull Pipeline pipeline,
@NotNull String executionId) |
Returns the specified execution of the pipeline.
|
@NotNull PipelineExecution |
PipelineExecutionApi.get(@NotNull String programId,
@NotNull String pipelineId,
@NotNull String executionId) |
Get the specified execution of the pipeline.
|
@NotNull Program |
ProgramApi.get(@NotNull String programId) |
Get the program with the specified id.
|
@NotNull Repository |
RepositoryApi.get(@NotNull Program program,
@NotNull String repositoryId) |
Get a specific repository in the program.
|
@NotNull Repository |
RepositoryApi.get(@NotNull String programId,
@NotNull String repositoryId) |
Get a specific repository in the program.
|
@NotNull Tenant |
TenantApi.get(@NotNull String tenantId) |
Gets the tenant with the specified identifier.
|
@NotNull String |
PipelineExecutionApi.getArtifactDownloadUrl(@NotNull PipelineExecutionStepState step,
String artifactId) |
Get the fully qualified URL to the artifact file.
|
@NotNull Optional<PipelineExecution> |
PipelineExecutionApi.getCurrent(@NotNull Pipeline pipeline) |
Get the current execution of the specified pipeline, if one exists.
|
@NotNull Optional<PipelineExecution> |
PipelineExecutionApi.getCurrent(@NotNull String programId,
@NotNull String pipelineId) |
Get the current execution of the specified pipeline, if one exists.
|
Optional<PipelineExecution> |
Pipeline.getCurrentExecution() |
Get the current execution of this pipeline, if it exists.
|
@NotNull PipelineExecutionStepState |
PipelineExecution.getCurrentStep() |
Get the current/active step.
|
String |
Environment.getDeveloperConsoleUrl() |
Retrieve the Developer Console URL for this Environment.
|
String |
Artifact.getDownloadUrl() |
The fully qualified download url for this artifact.
|
PipelineExecution |
Pipeline.getExecution(String executionId) |
Get the execution.
|
@NotNull PipelineExecution |
PipelineExecutionEndEvent.getExecution() |
Get the Pipeline Execution associated with the event.
|
@NotNull PipelineExecution |
PipelineExecutionStartEvent.getExecution() |
Get the Pipeline Execution associated with the event.
|
PipelineExecution |
PipelineExecutionStepState.getExecution() |
Get the execution associated with this step state.
|
@NotNull ContentFlow |
ContentSetApi.getFlow(@NotNull String programId,
@NotNull String id) |
Retrieve the content flow.
|
void |
PipelineExecutionStepState.getLog(File dir) |
Download the default log associated with this step, to the specified directory.
|
void |
PipelineExecutionStepState.getLog(String name,
File dir) |
Download the named log associated with this step, to the specified directory.
|
String |
Environment.getLogDownloadUrl(@NotNull LogOption option,
@NotNull LocalDate date) |
Retrieve the fully qualified URL to the log file for download.
|
String |
EnvironmentApi.getLogDownloadUrl(@NotNull Environment environment,
@NotNull LogOption option,
@NotNull LocalDate date) |
Get the fully qualified URL to the log file for download.
|
String |
EnvironmentApi.getLogDownloadUrl(@NotNull String programId,
@NotNull String environmentId,
@NotNull LogOption option,
@NotNull LocalDate date) |
Get the fully qualified URL to the log file for download.
|
@NotNull Collection<Metric> |
PipelineExecutionApi.getQualityGateResults(@NotNull PipelineExecution execution,
@NotNull StepAction action) |
Get the metrics for the specified execution and step, if any.
|
@NotNull RegionDeployment |
EnvironmentApi.getRegionDeployment(@NotNull String programId,
@NotNull String environmentId,
@NotNull String deploymentId) |
Get the region deployment.
|
@NotNull PipelineExecutionStepState |
PipelineExecution.getStep(@NotNull StepAction action) |
Get the specified action step.
|
String |
PipelineExecutionApi.getStepLogDownloadUrl(@NotNull PipelineExecution execution,
@NotNull StepAction action) |
Get the fully qualified URL to the specified step's log file.
|
String |
PipelineExecutionApi.getStepLogDownloadUrl(@NotNull PipelineExecution execution,
@NotNull StepAction action,
@NotNull String name) |
Get the fully qualified URL to the specified log file referenced by name, within the step.
|
String |
PipelineExecutionApi.getStepLogDownloadUrl(@NotNull String programId,
@NotNull String pipelineId,
@NotNull String executionId,
@NotNull StepAction action) |
Get the fully qualified URL to the specified step's log file.
|
String |
PipelineExecutionApi.getStepLogDownloadUrl(@NotNull String programId,
@NotNull String pipelineId,
@NotNull String executionId,
@NotNull StepAction action,
@NotNull String name) |
Get the fully qualified URL to the specified step's log file.
|
@NotNull PipelineExecutionStepState |
PipelineExecutionApi.getStepState(@NotNull PipelineExecution execution,
@NotNull StepAction action) |
Get the specified action step for the pipeline execution.
|
@NotNull PipelineExecutionStepState |
PipelineExecutionStepEndEvent.getStepState() |
Get the Pipeline Execution Step associated with the event.
|
@NotNull PipelineExecutionStepState |
PipelineExecutionStepStartEvent.getStepState() |
Get the Pipeline Execution Step associated with the event.
|
@NotNull PipelineExecutionStepState |
PipelineExecutionStepWaitingEvent.getStepState() |
Get the Pipeline Execution Step associated with the event.
|
Set<Variable> |
Environment.getVariables() |
List the variables configured in this environment.
|
@NotNull Set<Variable> |
EnvironmentApi.getVariables(@NotNull Environment environment) |
List all variables associated with the environment.
|
@NotNull Set<Variable> |
EnvironmentApi.getVariables(@NotNull String programId,
@NotNull String environmentId) |
List all variables associated with the environment.
|
Set<Variable> |
Pipeline.getVariables() |
Retrieve the variables associated with this pipeline.
|
@NotNull Set<Variable> |
PipelineApi.getVariables(@NotNull Pipeline pipeline) |
List all variables associated with the pipeline
|
@NotNull Set<Variable> |
PipelineApi.getVariables(@NotNull String programId,
@NotNull String pipelineId) |
List all variables associated with the pipeline
|
void |
Pipeline.invalidateCache() |
Invalidate the build cache for this pipeline.
|
void |
PipelineApi.invalidateCache(@NotNull Pipeline pipeline) |
Invalidate the build cache for the pipeline.
|
void |
PipelineApi.invalidateCache(@NotNull String programId,
@NotNull String pipelineId) |
Invalidate the build cache for the pipeline.
|
@NotNull Collection<ContentSet> |
ContentSetApi.list(@NotNull String programId) |
List content sets within the specified program.
|
@NotNull Collection<ContentSet> |
ContentSetApi.list(@NotNull String programId,
int limit) |
List content sets within the specified program, using the specified limit and starting at 0.
|
@NotNull Collection<ContentSet> |
ContentSetApi.list(@NotNull String programId,
int start,
int limit) |
List content sets within the specified program, using the specified limit and starting at the specified position.
|
@NotNull Collection<Environment> |
EnvironmentApi.list(@NotNull String programId) |
List all environments in the program.
|
@NotNull Collection<Environment> |
EnvironmentApi.list(@NotNull String programId,
Environment.Type type) |
List all environments in the program, of the specified type.
|
@NotNull Collection<Pipeline> |
PipelineApi.list(@NotNull Program program) |
List all pipelines within the specified program.
|
@NotNull Collection<Pipeline> |
PipelineApi.list(@NotNull String programId) |
List all pipelines within the specified program.
|
@NotNull Collection<Pipeline> |
PipelineApi.list(@NotNull String programId,
@NotNull Predicate<Pipeline> predicate) |
List all pipelines in the program that meet the predicate clause.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull Pipeline pipeline) |
List executions of the specified pipeline, using the default limit and starting at 0.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull Pipeline pipeline,
int limit) |
List executions of the specified pipeline, using the specified limit and starting at 0.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull Pipeline pipeline,
int start,
int limit) |
List executions of the specified pipeline, using the specified limit and starting at the specified position.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull String programId,
@NotNull String pipelineId) |
List executions of the specified pipeline, using the default limit and starting at 0.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull String programId,
@NotNull String pipelineId,
int limit) |
List executions of the specified pipeline, using the specified limit and starting at 0.
|
@NotNull Collection<PipelineExecution> |
PipelineExecutionApi.list(@NotNull String programId,
@NotNull String pipelineId,
int start,
int limit) |
List executions of the specified pipeline, using the specified limit and starting at the specified position.
|
@NotNull Collection<Program> |
ProgramApi.list(@NotNull Tenant tenant) |
List all programs for the specified tenant.
|
@NotNull Collection<Program> |
ProgramApi.list(@NotNull String tenantId) |
List all programs for the specified tenant.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull Program program) |
List all repositories for the specified program.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull Program program,
int limit) |
List all repositories for the specified program, up to the defined limit.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull Program program,
int start,
int limit) |
List all repositories for the specified program, from the starting position, up to the defined limit.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull String programId) |
List all repositories for the specified program.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull String programId,
int limit) |
List all repositories for the specified program, up to the defined limit.
|
@NotNull Collection<Repository> |
RepositoryApi.list(@NotNull String programId,
int start,
int limit) |
List all repositories for the specified program, from the starting position, up to the defined limit.
|
@NotNull Collection<Tenant> |
TenantApi.list() |
List the tenants associated with the IMS Org in the API Context
|
@NotNull Collection<Artifact> |
PipelineExecutionApi.listArtifacts(@NotNull PipelineExecutionStepState step) |
List all artifacts associated with the specified step.
|
Collection<String> |
Repository.listBranches() |
List all the branches associated with the repository.
|
@NotNull Collection<String> |
RepositoryApi.listBranches(@NotNull Repository repository) |
List all the branches associated with the repository.
|
@NotNull Collection<ContentFlow> |
ContentSetApi.listFlows(@NotNull String programId) |
List the content flows which exist in the specified program.
|
@NotNull Collection<ContentFlow> |
ContentSetApi.listFlows(@NotNull String programId,
int limit) |
List the content flows which exist in the specified program, using the specified limit and starting at 0.
|
@NotNull Collection<ContentFlow> |
ContentSetApi.listFlows(@NotNull String programId,
int start,
int limit) |
List the content flows which exist in the specified program, using the specified limit and starting at the specified position.
|
Collection<EnvironmentLog> |
Environment.listLogs(@NotNull LogOption option,
int days) |
List available logs of the specified type, for the number of days.
|
Collection<EnvironmentLog> |
EnvironmentApi.listLogs(@NotNull Environment environment,
@NotNull LogOption option,
int days) |
List logs of the specified type for the environment.
|
Collection<EnvironmentLog> |
EnvironmentApi.listLogs(@NotNull String programId,
@NotNull String environmentId,
@NotNull LogOption option,
int days) |
List logs of the specified type for the environment.
|
Collection<RegionDeployment> |
Environment.listRegionDeployments() |
List the deployment regions for this environment
|
@NotNull Collection<RegionDeployment> |
EnvironmentApi.listRegionDeployments(@NotNull Environment environment) |
Get the region deployment.
|
@NotNull Collection<RegionDeployment> |
EnvironmentApi.listRegionDeployments(@NotNull String programId,
@NotNull String environmentId) |
Get the region deployment.
|
Collection<Region> |
Program.listRegions() |
List all regions which can be used to create environments for this program.
|
@NotNull Collection<Region> |
ProgramApi.listRegions(@NotNull String programId) |
List all regions which can be used to create environments for the specified program.
|
@NotNull PipelineExecutionEvent |
PipelineExecutionApi.parseEvent(@NotNull String eventBody) |
Parse the provided string into an Event instance.
|
@NotNull PipelineExecutionEvent |
PipelineExecutionApi.parseEvent(@NotNull String eventBody,
@NotNull Map<String,String> requestHeader) |
Parse the provided body into an Event instance, validating the event as part of the parsing process.
|
void |
Environment.removeRegionDeployment(Region region) |
Remove the the the deployment from the specified region.
|
void |
EnvironmentApi.removeRegionDeployments(@NotNull Environment environment,
@NotNull Region... regions) |
Remove the deployment from the specified region.
|
void |
Environment.reset() |
Reset this environment, if it is of type RDE.
|
void |
EnvironmentApi.resetRde(@NotNull Environment environment) |
Reset the Rapid Development Environment.
|
void |
EnvironmentApi.resetRde(@NotNull String programId,
@NotNull String environmentId) |
Reset the Rapid Development Environment.
|
Set<Variable> |
Environment.setVariables(Variable... variables) |
Set the variables on this environment.
|
@NotNull Set<Variable> |
EnvironmentApi.setVariables(@NotNull Environment environment,
Variable... variables) |
Set the variables in the environment.
|
@NotNull Set<Variable> |
EnvironmentApi.setVariables(@NotNull String programId,
@NotNull String environmentId,
Variable... variables) |
Set the variables in the environment.
|
Set<Variable> |
Pipeline.setVariables(Variable... variables) |
Set the variables on this pipeline.
|
@NotNull Set<Variable> |
PipelineApi.setVariables(@NotNull Pipeline pipeline,
Variable... variables) |
Set the variables in the pipeline
|
@NotNull Set<Variable> |
PipelineApi.setVariables(@NotNull String programId,
@NotNull String pipelineId,
Variable... variables) |
Set the variables in the pipeline
|
@NotNull PipelineExecution |
PipelineExecutionApi.start(@NotNull Pipeline pipeline) |
Start the specified pipeline.
|
@NotNull PipelineExecution |
PipelineExecutionApi.start(@NotNull String programId,
@NotNull String pipelineId) |
Start the specified pipeline.
|
PipelineExecution |
Pipeline.startExecution() |
Start this pipeline.
|
@NotNull ContentFlow |
ContentSet.startFlow(@NotNull String srcEnvironmentId,
@NotNull String destEnvironmentId,
boolean includeAcl) |
Start a content flow between the specified environments, using the specified content set.
|
@NotNull ContentFlow |
ContentSetApi.startFlow(@NotNull String programId,
@NotNull String id,
@NotNull String srcEnvironmentId,
@NotNull String destEnvironmentId,
boolean includeAcl) |
Start a content flow between the specified environments, using the specified content set.
|
void |
ContentSet.update(String name,
String description,
Collection<ContentSet.PathDefinition> definitions) |
Update this content set with the changes.
|
@NotNull ContentSet |
ContentSetApi.update(@NotNull String programId,
@NotNull String id,
String name,
String description,
Collection<ContentSet.PathDefinition> definitions) |
Update the content set with the provided details.
|
Pipeline |
Pipeline.update(PipelineUpdate update) |
Update this pipeline with the specified changes.
|
@NotNull Pipeline |
PipelineApi.update(@NotNull Pipeline pipeline,
@NotNull PipelineUpdate updates) |
Change details about a pipeline.
|
@NotNull Pipeline |
PipelineApi.update(@NotNull String programId,
@NotNull String pipelineId,
@NotNull PipelineUpdate updates) |
Change details about a pipeline.
|