Interface CloudDeployGrpc.AsyncService (1.53.0)

public static interface CloudDeployGrpc.AsyncService

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Methods

abandonRelease(AbandonReleaseRequest request, StreamObserver<AbandonReleaseResponse> responseObserver)

public default void abandonRelease(AbandonReleaseRequest request, StreamObserver<AbandonReleaseResponse> responseObserver)

Abandons a Release in the Delivery Pipeline.

Parameters
Name Description
request AbandonReleaseRequest
responseObserver io.grpc.stub.StreamObserver<AbandonReleaseResponse>

advanceRollout(AdvanceRolloutRequest request, StreamObserver<AdvanceRolloutResponse> responseObserver)

public default void advanceRollout(AdvanceRolloutRequest request, StreamObserver<AdvanceRolloutResponse> responseObserver)

Advances a Rollout in a given project and location.

Parameters
Name Description
request AdvanceRolloutRequest
responseObserver io.grpc.stub.StreamObserver<AdvanceRolloutResponse>

approveRollout(ApproveRolloutRequest request, StreamObserver<ApproveRolloutResponse> responseObserver)

public default void approveRollout(ApproveRolloutRequest request, StreamObserver<ApproveRolloutResponse> responseObserver)

Approves a Rollout.

Parameters
Name Description
request ApproveRolloutRequest
responseObserver io.grpc.stub.StreamObserver<ApproveRolloutResponse>

cancelAutomationRun(CancelAutomationRunRequest request, StreamObserver<CancelAutomationRunResponse> responseObserver)

public default void cancelAutomationRun(CancelAutomationRunRequest request, StreamObserver<CancelAutomationRunResponse> responseObserver)

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

Parameters
Name Description
request CancelAutomationRunRequest
responseObserver io.grpc.stub.StreamObserver<CancelAutomationRunResponse>

cancelRollout(CancelRolloutRequest request, StreamObserver<CancelRolloutResponse> responseObserver)

public default void cancelRollout(CancelRolloutRequest request, StreamObserver<CancelRolloutResponse> responseObserver)

Cancels a Rollout in a given project and location.

Parameters
Name Description
request CancelRolloutRequest
responseObserver io.grpc.stub.StreamObserver<CancelRolloutResponse>

createAutomation(CreateAutomationRequest request, StreamObserver<Operation> responseObserver)

public default void createAutomation(CreateAutomationRequest request, StreamObserver<Operation> responseObserver)

Creates a new Automation in a given project and location.

Parameters
Name Description
request CreateAutomationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createCustomTargetType(CreateCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

public default void createCustomTargetType(CreateCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

Creates a new CustomTargetType in a given project and location.

Parameters
Name Description
request CreateCustomTargetTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createDeliveryPipeline(CreateDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

public default void createDeliveryPipeline(CreateDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name Description
request CreateDeliveryPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createDeployPolicy(CreateDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

public default void createDeployPolicy(CreateDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

Creates a new DeployPolicy in a given project and location.

Parameters
Name Description
request CreateDeployPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createRelease(CreateReleaseRequest request, StreamObserver<Operation> responseObserver)

public default void createRelease(CreateReleaseRequest request, StreamObserver<Operation> responseObserver)

Creates a new Release in a given project and location.

Parameters
Name Description
request CreateReleaseRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createRollout(CreateRolloutRequest request, StreamObserver<Operation> responseObserver)

public default void createRollout(CreateRolloutRequest request, StreamObserver<Operation> responseObserver)

Creates a new Rollout in a given project and location.

Parameters
Name Description
request CreateRolloutRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createTarget(CreateTargetRequest request, StreamObserver<Operation> responseObserver)

public default void createTarget(CreateTargetRequest request, StreamObserver<Operation> responseObserver)

Creates a new Target in a given project and location.

Parameters
Name Description
request CreateTargetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAutomation(DeleteAutomationRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAutomation(DeleteAutomationRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Automation resource.

Parameters
Name Description
request DeleteAutomationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteCustomTargetType(DeleteCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteCustomTargetType(DeleteCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

Deletes a single CustomTargetType.

Parameters
Name Description
request DeleteCustomTargetTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteDeliveryPipeline(DeleteDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

public default void deleteDeliveryPipeline(DeleteDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

Deletes a single DeliveryPipeline.

Parameters
Name Description
request DeleteDeliveryPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteDeployPolicy(DeleteDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

public default void deleteDeployPolicy(DeleteDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

Deletes a single DeployPolicy.

Parameters
Name Description
request DeleteDeployPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTarget(DeleteTargetRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTarget(DeleteTargetRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Target.

Parameters
Name Description
request DeleteTargetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAutomation(GetAutomationRequest request, StreamObserver<Automation> responseObserver)

public default void getAutomation(GetAutomationRequest request, StreamObserver<Automation> responseObserver)

Gets details of a single Automation.

Parameters
Name Description
request GetAutomationRequest
responseObserver io.grpc.stub.StreamObserver<Automation>

getAutomationRun(GetAutomationRunRequest request, StreamObserver<AutomationRun> responseObserver)

public default void getAutomationRun(GetAutomationRunRequest request, StreamObserver<AutomationRun> responseObserver)

Gets details of a single AutomationRun.

Parameters
Name Description
request GetAutomationRunRequest
responseObserver io.grpc.stub.StreamObserver<AutomationRun>

getConfig(GetConfigRequest request, StreamObserver<Config> responseObserver)

public default void getConfig(GetConfigRequest request, StreamObserver<Config> responseObserver)

Gets the configuration for a location.

Parameters
Name Description
request GetConfigRequest
responseObserver io.grpc.stub.StreamObserver<Config>

getCustomTargetType(GetCustomTargetTypeRequest request, StreamObserver<CustomTargetType> responseObserver)

public default void getCustomTargetType(GetCustomTargetTypeRequest request, StreamObserver<CustomTargetType> responseObserver)

Gets details of a single CustomTargetType.

Parameters
Name Description
request GetCustomTargetTypeRequest
responseObserver io.grpc.stub.StreamObserver<CustomTargetType>

getDeliveryPipeline(GetDeliveryPipelineRequest request, StreamObserver<DeliveryPipeline> responseObserver)

public default void getDeliveryPipeline(GetDeliveryPipelineRequest request, StreamObserver<DeliveryPipeline> responseObserver)

Gets details of a single DeliveryPipeline.

Parameters
Name Description
request GetDeliveryPipelineRequest
responseObserver io.grpc.stub.StreamObserver<DeliveryPipeline>

getDeployPolicy(GetDeployPolicyRequest request, StreamObserver<DeployPolicy> responseObserver)

public default void getDeployPolicy(GetDeployPolicyRequest request, StreamObserver<DeployPolicy> responseObserver)

Gets details of a single DeployPolicy.

Parameters
Name Description
request GetDeployPolicyRequest
responseObserver io.grpc.stub.StreamObserver<DeployPolicy>

getJobRun(GetJobRunRequest request, StreamObserver<JobRun> responseObserver)

public default void getJobRun(GetJobRunRequest request, StreamObserver<JobRun> responseObserver)

Gets details of a single JobRun.

Parameters
Name Description
request GetJobRunRequest
responseObserver io.grpc.stub.StreamObserver<JobRun>

getRelease(GetReleaseRequest request, StreamObserver<Release> responseObserver)

public default void getRelease(GetReleaseRequest request, StreamObserver<Release> responseObserver)

Gets details of a single Release.

Parameters
Name Description
request GetReleaseRequest
responseObserver io.grpc.stub.StreamObserver<Release>

getRollout(GetRolloutRequest request, StreamObserver<Rollout> responseObserver)

public default void getRollout(GetRolloutRequest request, StreamObserver<Rollout> responseObserver)

Gets details of a single Rollout.

Parameters
Name Description
request GetRolloutRequest
responseObserver io.grpc.stub.StreamObserver<Rollout>

getTarget(GetTargetRequest request, StreamObserver<Target> responseObserver)

public default void getTarget(GetTargetRequest request, StreamObserver<Target> responseObserver)

Gets details of a single Target.

Parameters
Name Description
request GetTargetRequest
responseObserver io.grpc.stub.StreamObserver<Target>

ignoreJob(IgnoreJobRequest request, StreamObserver<IgnoreJobResponse> responseObserver)

public default void ignoreJob(IgnoreJobRequest request, StreamObserver<IgnoreJobResponse> responseObserver)

Ignores the specified Job in a Rollout.

Parameters
Name Description
request IgnoreJobRequest
responseObserver io.grpc.stub.StreamObserver<IgnoreJobResponse>

listAutomationRuns(ListAutomationRunsRequest request, StreamObserver<ListAutomationRunsResponse> responseObserver)

public default void listAutomationRuns(ListAutomationRunsRequest request, StreamObserver<ListAutomationRunsResponse> responseObserver)

Lists AutomationRuns in a given project and location.

Parameters
Name Description
request ListAutomationRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListAutomationRunsResponse>

listAutomations(ListAutomationsRequest request, StreamObserver<ListAutomationsResponse> responseObserver)

public default void listAutomations(ListAutomationsRequest request, StreamObserver<ListAutomationsResponse> responseObserver)

Lists Automations in a given project and location.

Parameters
Name Description
request ListAutomationsRequest
responseObserver io.grpc.stub.StreamObserver<ListAutomationsResponse>

listCustomTargetTypes(ListCustomTargetTypesRequest request, StreamObserver<ListCustomTargetTypesResponse> responseObserver)

public default void listCustomTargetTypes(ListCustomTargetTypesRequest request, StreamObserver<ListCustomTargetTypesResponse> responseObserver)

Lists CustomTargetTypes in a given project and location.

Parameters
Name Description
request ListCustomTargetTypesRequest
responseObserver io.grpc.stub.StreamObserver<ListCustomTargetTypesResponse>

listDeliveryPipelines(ListDeliveryPipelinesRequest request, StreamObserver<ListDeliveryPipelinesResponse> responseObserver)

public default void listDeliveryPipelines(ListDeliveryPipelinesRequest request, StreamObserver<ListDeliveryPipelinesResponse> responseObserver)

Lists DeliveryPipelines in a given project and location.

Parameters
Name Description
request ListDeliveryPipelinesRequest
responseObserver io.grpc.stub.StreamObserver<ListDeliveryPipelinesResponse>

listDeployPolicies(ListDeployPoliciesRequest request, StreamObserver<ListDeployPoliciesResponse> responseObserver)

public default void listDeployPolicies(ListDeployPoliciesRequest request, StreamObserver<ListDeployPoliciesResponse> responseObserver)

Lists DeployPolicies in a given project and location.

Parameters
Name Description
request ListDeployPoliciesRequest
responseObserver io.grpc.stub.StreamObserver<ListDeployPoliciesResponse>

listJobRuns(ListJobRunsRequest request, StreamObserver<ListJobRunsResponse> responseObserver)

public default void listJobRuns(ListJobRunsRequest request, StreamObserver<ListJobRunsResponse> responseObserver)

Lists JobRuns in a given project and location.

Parameters
Name Description
request ListJobRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListJobRunsResponse>

listReleases(ListReleasesRequest request, StreamObserver<ListReleasesResponse> responseObserver)

public default void listReleases(ListReleasesRequest request, StreamObserver<ListReleasesResponse> responseObserver)

Lists Releases in a given project and location.

Parameters
Name Description
request ListReleasesRequest
responseObserver io.grpc.stub.StreamObserver<ListReleasesResponse>

listRollouts(ListRolloutsRequest request, StreamObserver<ListRolloutsResponse> responseObserver)

public default void listRollouts(ListRolloutsRequest request, StreamObserver<ListRolloutsResponse> responseObserver)

Lists Rollouts in a given project and location.

Parameters
Name Description
request ListRolloutsRequest
responseObserver io.grpc.stub.StreamObserver<ListRolloutsResponse>

listTargets(ListTargetsRequest request, StreamObserver<ListTargetsResponse> responseObserver)

public default void listTargets(ListTargetsRequest request, StreamObserver<ListTargetsResponse> responseObserver)

Lists Targets in a given project and location.

Parameters
Name Description
request ListTargetsRequest
responseObserver io.grpc.stub.StreamObserver<ListTargetsResponse>

retryJob(RetryJobRequest request, StreamObserver<RetryJobResponse> responseObserver)

public default void retryJob(RetryJobRequest request, StreamObserver<RetryJobResponse> responseObserver)

Retries the specified Job in a Rollout.

Parameters
Name Description
request RetryJobRequest
responseObserver io.grpc.stub.StreamObserver<RetryJobResponse>

rollbackTarget(RollbackTargetRequest request, StreamObserver<RollbackTargetResponse> responseObserver)

public default void rollbackTarget(RollbackTargetRequest request, StreamObserver<RollbackTargetResponse> responseObserver)

Creates a Rollout to roll back the specified target.

Parameters
Name Description
request RollbackTargetRequest
responseObserver io.grpc.stub.StreamObserver<RollbackTargetResponse>

terminateJobRun(TerminateJobRunRequest request, StreamObserver<TerminateJobRunResponse> responseObserver)

public default void terminateJobRun(TerminateJobRunRequest request, StreamObserver<TerminateJobRunResponse> responseObserver)

Terminates a Job Run in a given project and location.

Parameters
Name Description
request TerminateJobRunRequest
responseObserver io.grpc.stub.StreamObserver<TerminateJobRunResponse>

updateAutomation(UpdateAutomationRequest request, StreamObserver<Operation> responseObserver)

public default void updateAutomation(UpdateAutomationRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Automation resource.

Parameters
Name Description
request UpdateAutomationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateCustomTargetType(UpdateCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

public default void updateCustomTargetType(UpdateCustomTargetTypeRequest request, StreamObserver<Operation> responseObserver)

Updates a single CustomTargetType.

Parameters
Name Description
request UpdateCustomTargetTypeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateDeliveryPipeline(UpdateDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

public default void updateDeliveryPipeline(UpdateDeliveryPipelineRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single DeliveryPipeline.

Parameters
Name Description
request UpdateDeliveryPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateDeployPolicy(UpdateDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

public default void updateDeployPolicy(UpdateDeployPolicyRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single DeployPolicy.

Parameters
Name Description
request UpdateDeployPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateTarget(UpdateTargetRequest request, StreamObserver<Operation> responseObserver)

public default void updateTarget(UpdateTargetRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Target.

Parameters
Name Description
request UpdateTargetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>