Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class CloudDeployClient (1.93.0)

GitHub Repository

Product Reference

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(name);
 }

Note: close() needs to be called on the CloudDeployClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListDeliveryPipelines	Lists DeliveryPipelines in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDeliveryPipelines(ListDeliveryPipelinesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDeliveryPipelines(LocationName parent) listDeliveryPipelines(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDeliveryPipelinesPagedCallable() listDeliveryPipelinesCallable()
GetDeliveryPipeline	Gets details of a single DeliveryPipeline.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDeliveryPipeline(GetDeliveryPipelineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDeliveryPipeline(DeliveryPipelineName name) getDeliveryPipeline(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDeliveryPipelineCallable()
CreateDeliveryPipeline	Creates a new DeliveryPipeline in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDeliveryPipelineAsync(CreateDeliveryPipelineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createDeliveryPipelineAsync(LocationName parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId) createDeliveryPipelineAsync(String parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDeliveryPipelineOperationCallable() createDeliveryPipelineCallable()
UpdateDeliveryPipeline	Updates the parameters of a single DeliveryPipeline.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDeliveryPipelineAsync(UpdateDeliveryPipelineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateDeliveryPipelineAsync(DeliveryPipeline deliveryPipeline, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDeliveryPipelineOperationCallable() updateDeliveryPipelineCallable()
DeleteDeliveryPipeline	Deletes a single DeliveryPipeline.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteDeliveryPipelineAsync(DeliveryPipelineName name) deleteDeliveryPipelineAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteDeliveryPipelineOperationCallable() deleteDeliveryPipelineCallable()
ListTargets	Lists Targets in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTargets(ListTargetsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTargets(LocationName parent) listTargets(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listTargetsPagedCallable() listTargetsCallable()
RollbackTarget	Creates a `Rollout` to roll back the specified target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. rollbackTarget(RollbackTargetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. rollbackTarget(DeliveryPipelineName name, String targetId, String rolloutId) rollbackTarget(String name, String targetId, String rolloutId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. rollbackTargetCallable()
GetTarget	Gets details of a single Target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTarget(GetTargetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTarget(TargetName name) getTarget(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTargetCallable()
CreateTarget	Creates a new Target in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTargetAsync(CreateTargetRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createTargetAsync(LocationName parent, Target target, String targetId) createTargetAsync(String parent, Target target, String targetId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTargetOperationCallable() createTargetCallable()
UpdateTarget	Updates the parameters of a single Target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTargetAsync(UpdateTargetRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateTargetAsync(Target target, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTargetOperationCallable() updateTargetCallable()
DeleteTarget	Deletes a single Target.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTargetAsync(DeleteTargetRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteTargetAsync(TargetName name) deleteTargetAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTargetOperationCallable() deleteTargetCallable()
ListCustomTargetTypes	Lists CustomTargetTypes in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCustomTargetTypes(ListCustomTargetTypesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCustomTargetTypes(LocationName parent) listCustomTargetTypes(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCustomTargetTypesPagedCallable() listCustomTargetTypesCallable()
GetCustomTargetType	Gets details of a single CustomTargetType.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCustomTargetType(GetCustomTargetTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCustomTargetType(CustomTargetTypeName name) getCustomTargetType(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCustomTargetTypeCallable()
CreateCustomTargetType	Creates a new CustomTargetType in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCustomTargetTypeAsync(CreateCustomTargetTypeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createCustomTargetTypeAsync(LocationName parent, CustomTargetType customTargetType, String customTargetTypeId) createCustomTargetTypeAsync(String parent, CustomTargetType customTargetType, String customTargetTypeId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCustomTargetTypeOperationCallable() createCustomTargetTypeCallable()
UpdateCustomTargetType	Updates a single CustomTargetType.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCustomTargetTypeAsync(UpdateCustomTargetTypeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateCustomTargetTypeAsync(CustomTargetType customTargetType, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCustomTargetTypeOperationCallable() updateCustomTargetTypeCallable()
DeleteCustomTargetType	Deletes a single CustomTargetType.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteCustomTargetTypeAsync(DeleteCustomTargetTypeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteCustomTargetTypeAsync(CustomTargetTypeName name) deleteCustomTargetTypeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteCustomTargetTypeOperationCallable() deleteCustomTargetTypeCallable()
ListReleases	Lists Releases in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listReleases(ListReleasesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listReleases(DeliveryPipelineName parent) listReleases(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listReleasesPagedCallable() listReleasesCallable()
GetRelease	Gets details of a single Release.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRelease(GetReleaseRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRelease(ReleaseName name) getRelease(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getReleaseCallable()
CreateRelease	Creates a new Release in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createReleaseAsync(CreateReleaseRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createReleaseAsync(DeliveryPipelineName parent, Release release, String releaseId) createReleaseAsync(String parent, Release release, String releaseId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createReleaseOperationCallable() createReleaseCallable()
AbandonRelease	Abandons a Release in the Delivery Pipeline.	Request object method variants only take one parameter, a request object, which must be constructed before the call. abandonRelease(AbandonReleaseRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. abandonRelease(ReleaseName name) abandonRelease(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. abandonReleaseCallable()
CreateDeployPolicy	Creates a new DeployPolicy in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDeployPolicyAsync(CreateDeployPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createDeployPolicyAsync(LocationName parent, DeployPolicy deployPolicy, String deployPolicyId) createDeployPolicyAsync(String parent, DeployPolicy deployPolicy, String deployPolicyId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDeployPolicyOperationCallable() createDeployPolicyCallable()
UpdateDeployPolicy	Updates the parameters of a single DeployPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDeployPolicyAsync(UpdateDeployPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateDeployPolicyAsync(DeployPolicy deployPolicy, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDeployPolicyOperationCallable() updateDeployPolicyCallable()
DeleteDeployPolicy	Deletes a single DeployPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDeployPolicyAsync(DeleteDeployPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteDeployPolicyAsync(DeployPolicyName name) deleteDeployPolicyAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteDeployPolicyOperationCallable() deleteDeployPolicyCallable()
ListDeployPolicies	Lists DeployPolicies in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDeployPolicies(ListDeployPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDeployPolicies(LocationName parent) listDeployPolicies(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDeployPoliciesPagedCallable() listDeployPoliciesCallable()
GetDeployPolicy	Gets details of a single DeployPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDeployPolicy(GetDeployPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDeployPolicy(DeployPolicyName name) getDeployPolicy(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDeployPolicyCallable()
ApproveRollout	Approves a Rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. approveRollout(ApproveRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. approveRollout(RolloutName name) approveRollout(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. approveRolloutCallable()
AdvanceRollout	Advances a Rollout in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. advanceRollout(AdvanceRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. advanceRollout(RolloutName name, String phaseId) advanceRollout(String name, String phaseId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. advanceRolloutCallable()
CancelRollout	Cancels a Rollout in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. cancelRollout(CancelRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. cancelRollout(RolloutName name) cancelRollout(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. cancelRolloutCallable()
ListRollouts	Lists Rollouts in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRollouts(ListRolloutsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRollouts(ReleaseName parent) listRollouts(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRolloutsPagedCallable() listRolloutsCallable()
GetRollout	Gets details of a single Rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRollout(GetRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRollout(RolloutName name) getRollout(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRolloutCallable()
CreateRollout	Creates a new Rollout in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRolloutAsync(CreateRolloutRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createRolloutAsync(ReleaseName parent, Rollout rollout, String rolloutId) createRolloutAsync(String parent, Rollout rollout, String rolloutId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRolloutOperationCallable() createRolloutCallable()
IgnoreJob	Ignores the specified Job in a Rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. ignoreJob(IgnoreJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. ignoreJob(RolloutName rollout, String phaseId, String jobId) ignoreJob(String rollout, String phaseId, String jobId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. ignoreJobCallable()
RetryJob	Retries the specified Job in a Rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. retryJob(RetryJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. retryJob(RolloutName rollout, String phaseId, String jobId) retryJob(String rollout, String phaseId, String jobId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. retryJobCallable()
ListJobRuns	Lists JobRuns in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listJobRuns(ListJobRunsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listJobRuns(RolloutName parent) listJobRuns(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listJobRunsPagedCallable() listJobRunsCallable()
GetJobRun	Gets details of a single JobRun.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getJobRun(GetJobRunRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getJobRun(JobRunName name) getJobRun(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getJobRunCallable()
TerminateJobRun	Terminates a Job Run in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. terminateJobRun(TerminateJobRunRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. terminateJobRun(JobRunName name) terminateJobRun(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. terminateJobRunCallable()
GetConfig	Gets the configuration for a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getConfig(GetConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getConfig(ConfigName name) getConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getConfigCallable()
CreateAutomation	Creates a new Automation in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAutomationAsync(CreateAutomationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createAutomationAsync(DeliveryPipelineName parent, Automation automation, String automationId) createAutomationAsync(String parent, Automation automation, String automationId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAutomationOperationCallable() createAutomationCallable()
UpdateAutomation	Updates the parameters of a single Automation resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAutomationAsync(UpdateAutomationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateAutomationAsync(Automation automation, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAutomationOperationCallable() updateAutomationCallable()
DeleteAutomation	Deletes a single Automation resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAutomationAsync(DeleteAutomationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAutomationAsync(AutomationName name) deleteAutomationAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteAutomationOperationCallable() deleteAutomationCallable()
GetAutomation	Gets details of a single Automation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAutomation(GetAutomationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAutomation(AutomationName name) getAutomation(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAutomationCallable()
ListAutomations	Lists Automations in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAutomations(ListAutomationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAutomations(DeliveryPipelineName parent) listAutomations(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAutomationsPagedCallable() listAutomationsCallable()
GetAutomationRun	Gets details of a single AutomationRun.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAutomationRun(GetAutomationRunRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAutomationRun(AutomationRunName name) getAutomationRun(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAutomationRunCallable()
ListAutomationRuns	Lists AutomationRuns in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAutomationRuns(ListAutomationRunsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAutomationRuns(DeliveryPipelineName parent) listAutomationRuns(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAutomationRunsPagedCallable() listAutomationRunsCallable()
CancelAutomationRun	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. cancelAutomationRun(CancelAutomationRunRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. cancelAutomationRun(AutomationRunName name) cancelAutomationRun(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. cancelAutomationRunCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CloudDeploySettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudDeploySettings cloudDeploySettings =
     CloudDeploySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudDeployClient cloudDeployClient = CloudDeployClient.create(cloudDeploySettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudDeploySettings cloudDeploySettings =
     CloudDeploySettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudDeployClient cloudDeployClient = CloudDeployClient.create(cloudDeploySettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudDeploySettings cloudDeploySettings = CloudDeploySettings.newHttpJsonBuilder().build();
 CloudDeployClient cloudDeployClient = CloudDeployClient.create(cloudDeploySettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CloudDeployClient

Static Methods

create()

public static final CloudDeployClient create()

Constructs an instance of CloudDeployClient with default settings.

Returns
Type	Description
`CloudDeployClient`

Exceptions
Type	Description
`IOException`

create(CloudDeploySettings settings)

public static final CloudDeployClient create(CloudDeploySettings settings)

Constructs an instance of CloudDeployClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`CloudDeploySettings`

Returns
Type	Description
`CloudDeployClient`

Exceptions
Type	Description
`IOException`

create(CloudDeployStub stub)

public static final CloudDeployClient create(CloudDeployStub stub)

Constructs an instance of CloudDeployClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudDeploySettings).

Parameter
Name	Description
`stub`	`CloudDeployStub`

Returns
Type	Description
`CloudDeployClient`

Constructors

CloudDeployClient(CloudDeploySettings settings)

protected CloudDeployClient(CloudDeploySettings settings)

Constructs an instance of CloudDeployClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`CloudDeploySettings`

CloudDeployClient(CloudDeployStub stub)

protected CloudDeployClient(CloudDeployStub stub)

Parameter
Name	Description
`stub`	`CloudDeployStub`

Methods

abandonRelease(@Nullable ReleaseName name)

public final AbandonReleaseResponse abandonRelease(@Nullable ReleaseName name)

Abandons a Release in the Delivery Pipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ReleaseName name =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
   AbandonReleaseResponse response = cloudDeployClient.abandonRelease(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.ReleaseName` Required. Name of the Release. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.

Returns
Type	Description
`AbandonReleaseResponse`

abandonRelease(AbandonReleaseRequest request)

public final AbandonReleaseResponse abandonRelease(AbandonReleaseRequest request)

Abandons a Release in the Delivery Pipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AbandonReleaseRequest request =
       AbandonReleaseRequest.newBuilder()
           .setName(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .build();
   AbandonReleaseResponse response = cloudDeployClient.abandonRelease(request);
 }

Parameter
Name	Description
`request`	`AbandonReleaseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AbandonReleaseResponse`

abandonRelease(String name)

public final AbandonReleaseResponse abandonRelease(String name)

Abandons a Release in the Delivery Pipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
   AbandonReleaseResponse response = cloudDeployClient.abandonRelease(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the Release. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.

Returns
Type	Description
`AbandonReleaseResponse`

abandonReleaseCallable()

public final UnaryCallable<AbandonReleaseRequest,AbandonReleaseResponse> abandonReleaseCallable()

Abandons a Release in the Delivery Pipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AbandonReleaseRequest request =
       AbandonReleaseRequest.newBuilder()
           .setName(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .build();
   ApiFuture<AbandonReleaseResponse> future =
       cloudDeployClient.abandonReleaseCallable().futureCall(request);
   // Do something.
   AbandonReleaseResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<AbandonReleaseRequest,AbandonReleaseResponse>`

advanceRollout(@Nullable RolloutName name, String phaseId)

public final AdvanceRolloutResponse advanceRollout(@Nullable RolloutName name, String phaseId)

Advances a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName name =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   String phaseId = "phaseId-608264202";
   AdvanceRolloutResponse response = cloudDeployClient.advanceRollout(name, phaseId);
 }

Parameters
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID to advance the `Rollout` to.

Returns
Type	Description
`AdvanceRolloutResponse`

advanceRollout(AdvanceRolloutRequest request)

public final AdvanceRolloutResponse advanceRollout(AdvanceRolloutRequest request)

Advances a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AdvanceRolloutRequest request =
       AdvanceRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   AdvanceRolloutResponse response = cloudDeployClient.advanceRollout(request);
 }

Parameter
Name	Description
`request`	`AdvanceRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AdvanceRolloutResponse`

advanceRollout(String name, String phaseId)

public final AdvanceRolloutResponse advanceRollout(String name, String phaseId)

Advances a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   String phaseId = "phaseId-608264202";
   AdvanceRolloutResponse response = cloudDeployClient.advanceRollout(name, phaseId);
 }

Parameters
Name	Description
`name`	`String` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID to advance the `Rollout` to.

Returns
Type	Description
`AdvanceRolloutResponse`

advanceRolloutCallable()

public final UnaryCallable<AdvanceRolloutRequest,AdvanceRolloutResponse> advanceRolloutCallable()

Advances a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AdvanceRolloutRequest request =
       AdvanceRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<AdvanceRolloutResponse> future =
       cloudDeployClient.advanceRolloutCallable().futureCall(request);
   // Do something.
   AdvanceRolloutResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<AdvanceRolloutRequest,AdvanceRolloutResponse>`

approveRollout(@Nullable RolloutName name)

public final ApproveRolloutResponse approveRollout(@Nullable RolloutName name)

Approves a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName name =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   ApproveRolloutResponse response = cloudDeployClient.approveRollout(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.

Returns
Type	Description
`ApproveRolloutResponse`

approveRollout(ApproveRolloutRequest request)

public final ApproveRolloutResponse approveRollout(ApproveRolloutRequest request)

Approves a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ApproveRolloutRequest request =
       ApproveRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setApproved(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApproveRolloutResponse response = cloudDeployClient.approveRollout(request);
 }

Parameter
Name	Description
`request`	`ApproveRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ApproveRolloutResponse`

approveRollout(String name)

public final ApproveRolloutResponse approveRollout(String name)

Approves a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   ApproveRolloutResponse response = cloudDeployClient.approveRollout(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.

Returns
Type	Description
`ApproveRolloutResponse`

approveRolloutCallable()

public final UnaryCallable<ApproveRolloutRequest,ApproveRolloutResponse> approveRolloutCallable()

Approves a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ApproveRolloutRequest request =
       ApproveRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setApproved(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<ApproveRolloutResponse> future =
       cloudDeployClient.approveRolloutCallable().futureCall(request);
   // Do something.
   ApproveRolloutResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ApproveRolloutRequest,ApproveRolloutResponse>`

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

cancelAutomationRun(@Nullable AutomationRunName name)

public final CancelAutomationRunResponse cancelAutomationRun(@Nullable AutomationRunName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AutomationRunName name =
       AutomationRunName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]");
   CancelAutomationRunResponse response = cloudDeployClient.cancelAutomationRun(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.AutomationRunName` Required. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.

Returns
Type	Description
`CancelAutomationRunResponse`

cancelAutomationRun(CancelAutomationRunRequest request)

public final CancelAutomationRunResponse cancelAutomationRun(CancelAutomationRunRequest request)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CancelAutomationRunRequest request =
       CancelAutomationRunRequest.newBuilder()
           .setName(
               AutomationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
                   .toString())
           .build();
   CancelAutomationRunResponse response = cloudDeployClient.cancelAutomationRun(request);
 }

Parameter
Name	Description
`request`	`CancelAutomationRunRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CancelAutomationRunResponse`

cancelAutomationRun(String name)

public final CancelAutomationRunResponse cancelAutomationRun(String name)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       AutomationRunName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
           .toString();
   CancelAutomationRunResponse response = cloudDeployClient.cancelAutomationRun(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.

Returns
Type	Description
`CancelAutomationRunResponse`

cancelAutomationRunCallable()

public final UnaryCallable<CancelAutomationRunRequest,CancelAutomationRunResponse> cancelAutomationRunCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CancelAutomationRunRequest request =
       CancelAutomationRunRequest.newBuilder()
           .setName(
               AutomationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
                   .toString())
           .build();
   ApiFuture<CancelAutomationRunResponse> future =
       cloudDeployClient.cancelAutomationRunCallable().futureCall(request);
   // Do something.
   CancelAutomationRunResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CancelAutomationRunRequest,CancelAutomationRunResponse>`

cancelRollout(@Nullable RolloutName name)

public final CancelRolloutResponse cancelRollout(@Nullable RolloutName name)

Cancels a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName name =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   CancelRolloutResponse response = cloudDeployClient.cancelRollout(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.

Returns
Type	Description
`CancelRolloutResponse`

cancelRollout(CancelRolloutRequest request)

public final CancelRolloutResponse cancelRollout(CancelRolloutRequest request)

Cancels a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CancelRolloutRequest request =
       CancelRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   CancelRolloutResponse response = cloudDeployClient.cancelRollout(request);
 }

Parameter
Name	Description
`request`	`CancelRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CancelRolloutResponse`

cancelRollout(String name)

public final CancelRolloutResponse cancelRollout(String name)

Cancels a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   CancelRolloutResponse response = cloudDeployClient.cancelRollout(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.

Returns
Type	Description
`CancelRolloutResponse`

cancelRolloutCallable()

public final UnaryCallable<CancelRolloutRequest,CancelRolloutResponse> cancelRolloutCallable()

Cancels a Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CancelRolloutRequest request =
       CancelRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<CancelRolloutResponse> future =
       cloudDeployClient.cancelRolloutCallable().futureCall(request);
   // Do something.
   CancelRolloutResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CancelRolloutRequest,CancelRolloutResponse>`

close()

public final void close()

createAutomationAsync(@Nullable DeliveryPipelineName parent, Automation automation, String automationId)

public final OperationFuture<Automation,OperationMetadata> createAutomationAsync(@Nullable DeliveryPipelineName parent, Automation automation, String automationId)

Creates a new Automation in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   Automation automation = Automation.newBuilder().build();
   String automationId = "automationId64173202";
   Automation response =
       cloudDeployClient.createAutomationAsync(parent, automation, automationId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`automation`	`Automation` Required. The `Automation` to create.
`automationId`	`String` Required. ID of the `Automation`.

Returns
Type	Description
`OperationFuture<Automation,OperationMetadata>`

createAutomationAsync(CreateAutomationRequest request)

public final OperationFuture<Automation,OperationMetadata> createAutomationAsync(CreateAutomationRequest request)

Creates a new Automation in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateAutomationRequest request =
       CreateAutomationRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setAutomationId("automationId64173202")
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   Automation response = cloudDeployClient.createAutomationAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateAutomationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Automation,OperationMetadata>`

createAutomationAsync(String parent, Automation automation, String automationId)

public final OperationFuture<Automation,OperationMetadata> createAutomationAsync(String parent, Automation automation, String automationId)

Creates a new Automation in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   Automation automation = Automation.newBuilder().build();
   String automationId = "automationId64173202";
   Automation response =
       cloudDeployClient.createAutomationAsync(parent, automation, automationId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`automation`	`Automation` Required. The `Automation` to create.
`automationId`	`String` Required. ID of the `Automation`.

Returns
Type	Description
`OperationFuture<Automation,OperationMetadata>`

createAutomationCallable()

public final UnaryCallable<CreateAutomationRequest,Operation> createAutomationCallable()

Creates a new Automation in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateAutomationRequest request =
       CreateAutomationRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setAutomationId("automationId64173202")
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.createAutomationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateAutomationRequest,Operation>`

createAutomationOperationCallable()

public final OperationCallable<CreateAutomationRequest,Automation,OperationMetadata> createAutomationOperationCallable()

Creates a new Automation in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateAutomationRequest request =
       CreateAutomationRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setAutomationId("automationId64173202")
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Automation, OperationMetadata> future =
       cloudDeployClient.createAutomationOperationCallable().futureCall(request);
   // Do something.
   Automation response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateAutomationRequest,Automation,OperationMetadata>`

createCustomTargetTypeAsync(@Nullable LocationName parent, CustomTargetType customTargetType, String customTargetTypeId)

public final OperationFuture<CustomTargetType,OperationMetadata> createCustomTargetTypeAsync(@Nullable LocationName parent, CustomTargetType customTargetType, String customTargetTypeId)

Creates a new CustomTargetType in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CustomTargetType customTargetType = CustomTargetType.newBuilder().build();
   String customTargetTypeId = "customTargetTypeId1451302135";
   CustomTargetType response =
       cloudDeployClient
           .createCustomTargetTypeAsync(parent, customTargetType, customTargetTypeId)
           .get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent collection in which the `CustomTargetType` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`customTargetType`	`CustomTargetType` Required. The `CustomTargetType` to create.
`customTargetTypeId`	`String` Required. ID of the `CustomTargetType`.

Returns
Type	Description
`OperationFuture<CustomTargetType,OperationMetadata>`

createCustomTargetTypeAsync(CreateCustomTargetTypeRequest request)

public final OperationFuture<CustomTargetType,OperationMetadata> createCustomTargetTypeAsync(CreateCustomTargetTypeRequest request)

Creates a new CustomTargetType in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateCustomTargetTypeRequest request =
       CreateCustomTargetTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCustomTargetTypeId("customTargetTypeId1451302135")
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   CustomTargetType response = cloudDeployClient.createCustomTargetTypeAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateCustomTargetTypeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<CustomTargetType,OperationMetadata>`

createCustomTargetTypeAsync(String parent, CustomTargetType customTargetType, String customTargetTypeId)

public final OperationFuture<CustomTargetType,OperationMetadata> createCustomTargetTypeAsync(String parent, CustomTargetType customTargetType, String customTargetTypeId)

Creates a new CustomTargetType in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CustomTargetType customTargetType = CustomTargetType.newBuilder().build();
   String customTargetTypeId = "customTargetTypeId1451302135";
   CustomTargetType response =
       cloudDeployClient
           .createCustomTargetTypeAsync(parent, customTargetType, customTargetTypeId)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `CustomTargetType` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`customTargetType`	`CustomTargetType` Required. The `CustomTargetType` to create.
`customTargetTypeId`	`String` Required. ID of the `CustomTargetType`.

Returns
Type	Description
`OperationFuture<CustomTargetType,OperationMetadata>`

createCustomTargetTypeCallable()

public final UnaryCallable<CreateCustomTargetTypeRequest,Operation> createCustomTargetTypeCallable()

Creates a new CustomTargetType in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateCustomTargetTypeRequest request =
       CreateCustomTargetTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCustomTargetTypeId("customTargetTypeId1451302135")
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.createCustomTargetTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateCustomTargetTypeRequest,Operation>`

createCustomTargetTypeOperationCallable()

public final OperationCallable<CreateCustomTargetTypeRequest,CustomTargetType,OperationMetadata> createCustomTargetTypeOperationCallable()

Creates a new CustomTargetType in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateCustomTargetTypeRequest request =
       CreateCustomTargetTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCustomTargetTypeId("customTargetTypeId1451302135")
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<CustomTargetType, OperationMetadata> future =
       cloudDeployClient.createCustomTargetTypeOperationCallable().futureCall(request);
   // Do something.
   CustomTargetType response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateCustomTargetTypeRequest,CustomTargetType,OperationMetadata>`

createDeliveryPipelineAsync(@Nullable LocationName parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId)

public final OperationFuture<DeliveryPipeline,OperationMetadata> createDeliveryPipelineAsync(@Nullable LocationName parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId)

Creates a new DeliveryPipeline in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeliveryPipeline deliveryPipeline = DeliveryPipeline.newBuilder().build();
   String deliveryPipelineId = "deliveryPipelineId-632411535";
   DeliveryPipeline response =
       cloudDeployClient
           .createDeliveryPipelineAsync(parent, deliveryPipeline, deliveryPipelineId)
           .get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`deliveryPipeline`	`DeliveryPipeline` Required. The `DeliveryPipeline` to create.
`deliveryPipelineId`	`String` Required. ID of the `DeliveryPipeline`.

Returns
Type	Description
`OperationFuture<DeliveryPipeline,OperationMetadata>`

createDeliveryPipelineAsync(CreateDeliveryPipelineRequest request)

public final OperationFuture<DeliveryPipeline,OperationMetadata> createDeliveryPipelineAsync(CreateDeliveryPipelineRequest request)

Creates a new DeliveryPipeline in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeliveryPipelineRequest request =
       CreateDeliveryPipelineRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeliveryPipelineId("deliveryPipelineId-632411535")
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   DeliveryPipeline response = cloudDeployClient.createDeliveryPipelineAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateDeliveryPipelineRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<DeliveryPipeline,OperationMetadata>`

createDeliveryPipelineAsync(String parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId)

public final OperationFuture<DeliveryPipeline,OperationMetadata> createDeliveryPipelineAsync(String parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId)

Creates a new DeliveryPipeline in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DeliveryPipeline deliveryPipeline = DeliveryPipeline.newBuilder().build();
   String deliveryPipelineId = "deliveryPipelineId-632411535";
   DeliveryPipeline response =
       cloudDeployClient
           .createDeliveryPipelineAsync(parent, deliveryPipeline, deliveryPipelineId)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`deliveryPipeline`	`DeliveryPipeline` Required. The `DeliveryPipeline` to create.
`deliveryPipelineId`	`String` Required. ID of the `DeliveryPipeline`.

Returns
Type	Description
`OperationFuture<DeliveryPipeline,OperationMetadata>`

createDeliveryPipelineCallable()

public final UnaryCallable<CreateDeliveryPipelineRequest,Operation> createDeliveryPipelineCallable()

Creates a new DeliveryPipeline in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeliveryPipelineRequest request =
       CreateDeliveryPipelineRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeliveryPipelineId("deliveryPipelineId-632411535")
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.createDeliveryPipelineCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateDeliveryPipelineRequest,Operation>`

createDeliveryPipelineOperationCallable()

public final OperationCallable<CreateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata> createDeliveryPipelineOperationCallable()

Creates a new DeliveryPipeline in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeliveryPipelineRequest request =
       CreateDeliveryPipelineRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeliveryPipelineId("deliveryPipelineId-632411535")
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<DeliveryPipeline, OperationMetadata> future =
       cloudDeployClient.createDeliveryPipelineOperationCallable().futureCall(request);
   // Do something.
   DeliveryPipeline response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata>`

createDeployPolicyAsync(@Nullable LocationName parent, DeployPolicy deployPolicy, String deployPolicyId)

public final OperationFuture<DeployPolicy,OperationMetadata> createDeployPolicyAsync(@Nullable LocationName parent, DeployPolicy deployPolicy, String deployPolicyId)

Creates a new DeployPolicy in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeployPolicy deployPolicy = DeployPolicy.newBuilder().build();
   String deployPolicyId = "deployPolicyId-1490278412";
   DeployPolicy response =
       cloudDeployClient.createDeployPolicyAsync(parent, deployPolicy, deployPolicyId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`deployPolicy`	`DeployPolicy` Required. The `DeployPolicy` to create.
`deployPolicyId`	`String` Required. ID of the `DeployPolicy`.

Returns
Type	Description
`OperationFuture<DeployPolicy,OperationMetadata>`

createDeployPolicyAsync(CreateDeployPolicyRequest request)

public final OperationFuture<DeployPolicy,OperationMetadata> createDeployPolicyAsync(CreateDeployPolicyRequest request)

Creates a new DeployPolicy in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeployPolicyRequest request =
       CreateDeployPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeployPolicyId("deployPolicyId-1490278412")
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   DeployPolicy response = cloudDeployClient.createDeployPolicyAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateDeployPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<DeployPolicy,OperationMetadata>`

createDeployPolicyAsync(String parent, DeployPolicy deployPolicy, String deployPolicyId)

public final OperationFuture<DeployPolicy,OperationMetadata> createDeployPolicyAsync(String parent, DeployPolicy deployPolicy, String deployPolicyId)

Creates a new DeployPolicy in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DeployPolicy deployPolicy = DeployPolicy.newBuilder().build();
   String deployPolicyId = "deployPolicyId-1490278412";
   DeployPolicy response =
       cloudDeployClient.createDeployPolicyAsync(parent, deployPolicy, deployPolicyId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`deployPolicy`	`DeployPolicy` Required. The `DeployPolicy` to create.
`deployPolicyId`	`String` Required. ID of the `DeployPolicy`.

Returns
Type	Description
`OperationFuture<DeployPolicy,OperationMetadata>`

createDeployPolicyCallable()

public final UnaryCallable<CreateDeployPolicyRequest,Operation> createDeployPolicyCallable()

Creates a new DeployPolicy in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeployPolicyRequest request =
       CreateDeployPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeployPolicyId("deployPolicyId-1490278412")
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.createDeployPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateDeployPolicyRequest,Operation>`

createDeployPolicyOperationCallable()

public final OperationCallable<CreateDeployPolicyRequest,DeployPolicy,OperationMetadata> createDeployPolicyOperationCallable()

Creates a new DeployPolicy in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateDeployPolicyRequest request =
       CreateDeployPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeployPolicyId("deployPolicyId-1490278412")
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<DeployPolicy, OperationMetadata> future =
       cloudDeployClient.createDeployPolicyOperationCallable().futureCall(request);
   // Do something.
   DeployPolicy response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateDeployPolicyRequest,DeployPolicy,OperationMetadata>`

createReleaseAsync(@Nullable DeliveryPipelineName parent, Release release, String releaseId)

public final OperationFuture<Release,OperationMetadata> createReleaseAsync(@Nullable DeliveryPipelineName parent, Release release, String releaseId)

Creates a new Release in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   Release release = Release.newBuilder().build();
   String releaseId = "releaseId89607042";
   Release response = cloudDeployClient.createReleaseAsync(parent, release, releaseId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`release`	`Release` Required. The `Release` to create.
`releaseId`	`String` Required. ID of the `Release`.

Returns
Type	Description
`OperationFuture<Release,OperationMetadata>`

createReleaseAsync(CreateReleaseRequest request)

public final OperationFuture<Release,OperationMetadata> createReleaseAsync(CreateReleaseRequest request)

Creates a new Release in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateReleaseRequest request =
       CreateReleaseRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setReleaseId("releaseId89607042")
           .setRelease(Release.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   Release response = cloudDeployClient.createReleaseAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateReleaseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Release,OperationMetadata>`

createReleaseAsync(String parent, Release release, String releaseId)

public final OperationFuture<Release,OperationMetadata> createReleaseAsync(String parent, Release release, String releaseId)

Creates a new Release in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   Release release = Release.newBuilder().build();
   String releaseId = "releaseId89607042";
   Release response = cloudDeployClient.createReleaseAsync(parent, release, releaseId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`release`	`Release` Required. The `Release` to create.
`releaseId`	`String` Required. ID of the `Release`.

Returns
Type	Description
`OperationFuture<Release,OperationMetadata>`

createReleaseCallable()

public final UnaryCallable<CreateReleaseRequest,Operation> createReleaseCallable()

Creates a new Release in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateReleaseRequest request =
       CreateReleaseRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setReleaseId("releaseId89607042")
           .setRelease(Release.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future = cloudDeployClient.createReleaseCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateReleaseRequest,Operation>`

createReleaseOperationCallable()

public final OperationCallable<CreateReleaseRequest,Release,OperationMetadata> createReleaseOperationCallable()

Creates a new Release in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateReleaseRequest request =
       CreateReleaseRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setReleaseId("releaseId89607042")
           .setRelease(Release.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   OperationFuture<Release, OperationMetadata> future =
       cloudDeployClient.createReleaseOperationCallable().futureCall(request);
   // Do something.
   Release response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateReleaseRequest,Release,OperationMetadata>`

createRolloutAsync(@Nullable ReleaseName parent, Rollout rollout, String rolloutId)

public final OperationFuture<Rollout,OperationMetadata> createRolloutAsync(@Nullable ReleaseName parent, Rollout rollout, String rolloutId)

Creates a new Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ReleaseName parent =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
   Rollout rollout = Rollout.newBuilder().build();
   String rolloutId = "rolloutId551248556";
   Rollout response = cloudDeployClient.createRolloutAsync(parent, rollout, rolloutId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.ReleaseName` Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
`rollout`	`Rollout` Required. The `Rollout` to create.
`rolloutId`	`String` Required. ID of the `Rollout`.

Returns
Type	Description
`OperationFuture<Rollout,OperationMetadata>`

createRolloutAsync(CreateRolloutRequest request)

public final OperationFuture<Rollout,OperationMetadata> createRolloutAsync(CreateRolloutRequest request)

Creates a new Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateRolloutRequest request =
       CreateRolloutRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setRolloutId("rolloutId551248556")
           .setRollout(Rollout.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .setStartingPhaseId("startingPhaseId-326529130")
           .build();
   Rollout response = cloudDeployClient.createRolloutAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Rollout,OperationMetadata>`

createRolloutAsync(String parent, Rollout rollout, String rolloutId)

public final OperationFuture<Rollout,OperationMetadata> createRolloutAsync(String parent, Rollout rollout, String rolloutId)

Creates a new Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
   Rollout rollout = Rollout.newBuilder().build();
   String rolloutId = "rolloutId551248556";
   Rollout response = cloudDeployClient.createRolloutAsync(parent, rollout, rolloutId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
`rollout`	`Rollout` Required. The `Rollout` to create.
`rolloutId`	`String` Required. ID of the `Rollout`.

Returns
Type	Description
`OperationFuture<Rollout,OperationMetadata>`

createRolloutCallable()

public final UnaryCallable<CreateRolloutRequest,Operation> createRolloutCallable()

Creates a new Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateRolloutRequest request =
       CreateRolloutRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setRolloutId("rolloutId551248556")
           .setRollout(Rollout.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .setStartingPhaseId("startingPhaseId-326529130")
           .build();
   ApiFuture<Operation> future = cloudDeployClient.createRolloutCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRolloutRequest,Operation>`

createRolloutOperationCallable()

public final OperationCallable<CreateRolloutRequest,Rollout,OperationMetadata> createRolloutOperationCallable()

Creates a new Rollout in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateRolloutRequest request =
       CreateRolloutRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setRolloutId("rolloutId551248556")
           .setRollout(Rollout.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .setStartingPhaseId("startingPhaseId-326529130")
           .build();
   OperationFuture<Rollout, OperationMetadata> future =
       cloudDeployClient.createRolloutOperationCallable().futureCall(request);
   // Do something.
   Rollout response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateRolloutRequest,Rollout,OperationMetadata>`

createTargetAsync(@Nullable LocationName parent, Target target, String targetId)

public final OperationFuture<Target,OperationMetadata> createTargetAsync(@Nullable LocationName parent, Target target, String targetId)

Creates a new Target in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Target target = Target.newBuilder().build();
   String targetId = "targetId-441951604";
   Target response = cloudDeployClient.createTargetAsync(parent, target, targetId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent collection in which the `Target` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`target`	`Target` Required. The `Target` to create.
`targetId`	`String` Required. ID of the `Target`.

Returns
Type	Description
`OperationFuture<Target,OperationMetadata>`

createTargetAsync(CreateTargetRequest request)

public final OperationFuture<Target,OperationMetadata> createTargetAsync(CreateTargetRequest request)

Creates a new Target in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateTargetRequest request =
       CreateTargetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetId("targetId-441951604")
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   Target response = cloudDeployClient.createTargetAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateTargetRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Target,OperationMetadata>`

createTargetAsync(String parent, Target target, String targetId)

public final OperationFuture<Target,OperationMetadata> createTargetAsync(String parent, Target target, String targetId)

Creates a new Target in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Target target = Target.newBuilder().build();
   String targetId = "targetId-441951604";
   Target response = cloudDeployClient.createTargetAsync(parent, target, targetId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent collection in which the `Target` must be created. The format is `projects/{project_id}/locations/{location_name}`.
`target`	`Target` Required. The `Target` to create.
`targetId`	`String` Required. ID of the `Target`.

Returns
Type	Description
`OperationFuture<Target,OperationMetadata>`

createTargetCallable()

public final UnaryCallable<CreateTargetRequest,Operation> createTargetCallable()

Creates a new Target in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateTargetRequest request =
       CreateTargetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetId("targetId-441951604")
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = cloudDeployClient.createTargetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateTargetRequest,Operation>`

createTargetOperationCallable()

public final OperationCallable<CreateTargetRequest,Target,OperationMetadata> createTargetOperationCallable()

Creates a new Target in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CreateTargetRequest request =
       CreateTargetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTargetId("targetId-441951604")
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Target, OperationMetadata> future =
       cloudDeployClient.createTargetOperationCallable().futureCall(request);
   // Do something.
   Target response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateTargetRequest,Target,OperationMetadata>`

deleteAutomationAsync(@Nullable AutomationName name)

public final OperationFuture<Empty,OperationMetadata> deleteAutomationAsync(@Nullable AutomationName name)

Deletes a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AutomationName name =
       AutomationName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]");
   cloudDeployClient.deleteAutomationAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.AutomationName` Required. The name of the `Automation` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteAutomationAsync(DeleteAutomationRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAutomationAsync(DeleteAutomationRequest request)

Deletes a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteAutomationRequest request =
       DeleteAutomationRequest.newBuilder()
           .setName(
               AutomationName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   cloudDeployClient.deleteAutomationAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteAutomationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteAutomationAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteAutomationAsync(String name)

Deletes a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       AutomationName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
           .toString();
   cloudDeployClient.deleteAutomationAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the `Automation` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteAutomationCallable()

public final UnaryCallable<DeleteAutomationRequest,Operation> deleteAutomationCallable()

Deletes a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteAutomationRequest request =
       DeleteAutomationRequest.newBuilder()
           .setName(
               AutomationName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.deleteAutomationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteAutomationRequest,Operation>`

deleteAutomationOperationCallable()

public final OperationCallable<DeleteAutomationRequest,Empty,OperationMetadata> deleteAutomationOperationCallable()

Deletes a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteAutomationRequest request =
       DeleteAutomationRequest.newBuilder()
           .setName(
               AutomationName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       cloudDeployClient.deleteAutomationOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteAutomationRequest,Empty,OperationMetadata>`

deleteCustomTargetTypeAsync(@Nullable CustomTargetTypeName name)

public final OperationFuture<Empty,OperationMetadata> deleteCustomTargetTypeAsync(@Nullable CustomTargetTypeName name)

Deletes a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CustomTargetTypeName name =
       CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]");
   cloudDeployClient.deleteCustomTargetTypeAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.CustomTargetTypeName` Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteCustomTargetTypeAsync(DeleteCustomTargetTypeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteCustomTargetTypeAsync(DeleteCustomTargetTypeRequest request)

Deletes a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteCustomTargetTypeRequest request =
       DeleteCustomTargetTypeRequest.newBuilder()
           .setName(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   cloudDeployClient.deleteCustomTargetTypeAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteCustomTargetTypeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteCustomTargetTypeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteCustomTargetTypeAsync(String name)

Deletes a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]").toString();
   cloudDeployClient.deleteCustomTargetTypeAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteCustomTargetTypeCallable()

public final UnaryCallable<DeleteCustomTargetTypeRequest,Operation> deleteCustomTargetTypeCallable()

Deletes a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteCustomTargetTypeRequest request =
       DeleteCustomTargetTypeRequest.newBuilder()
           .setName(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.deleteCustomTargetTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteCustomTargetTypeRequest,Operation>`

deleteCustomTargetTypeOperationCallable()

public final OperationCallable<DeleteCustomTargetTypeRequest,Empty,OperationMetadata> deleteCustomTargetTypeOperationCallable()

Deletes a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteCustomTargetTypeRequest request =
       DeleteCustomTargetTypeRequest.newBuilder()
           .setName(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       cloudDeployClient.deleteCustomTargetTypeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteCustomTargetTypeRequest,Empty,OperationMetadata>`

deleteDeliveryPipelineAsync(@Nullable DeliveryPipelineName name)

public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(@Nullable DeliveryPipelineName name)

Deletes a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   cloudDeployClient.deleteDeliveryPipelineAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request)

Deletes a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeliveryPipelineRequest request =
       DeleteDeliveryPipelineRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setForce(true)
           .setEtag("etag3123477")
           .build();
   cloudDeployClient.deleteDeliveryPipelineAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteDeliveryPipelineRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeliveryPipelineAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(String name)

Deletes a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   cloudDeployClient.deleteDeliveryPipelineAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeliveryPipelineCallable()

public final UnaryCallable<DeleteDeliveryPipelineRequest,Operation> deleteDeliveryPipelineCallable()

Deletes a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeliveryPipelineRequest request =
       DeleteDeliveryPipelineRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setForce(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.deleteDeliveryPipelineCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteDeliveryPipelineRequest,Operation>`

deleteDeliveryPipelineOperationCallable()

public final OperationCallable<DeleteDeliveryPipelineRequest,Empty,OperationMetadata> deleteDeliveryPipelineOperationCallable()

Deletes a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeliveryPipelineRequest request =
       DeleteDeliveryPipelineRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setForce(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       cloudDeployClient.deleteDeliveryPipelineOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteDeliveryPipelineRequest,Empty,OperationMetadata>`

deleteDeployPolicyAsync(@Nullable DeployPolicyName name)

public final OperationFuture<Empty,OperationMetadata> deleteDeployPolicyAsync(@Nullable DeployPolicyName name)

Deletes a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeployPolicyName name = DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]");
   cloudDeployClient.deleteDeployPolicyAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeployPolicyName` Required. The name of the `DeployPolicy` to delete. The format is `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeployPolicyAsync(DeleteDeployPolicyRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDeployPolicyAsync(DeleteDeployPolicyRequest request)

Deletes a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeployPolicyRequest request =
       DeleteDeployPolicyRequest.newBuilder()
           .setName(DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   cloudDeployClient.deleteDeployPolicyAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteDeployPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeployPolicyAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDeployPolicyAsync(String name)

Deletes a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name = DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString();
   cloudDeployClient.deleteDeployPolicyAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the `DeployPolicy` to delete. The format is `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDeployPolicyCallable()

public final UnaryCallable<DeleteDeployPolicyRequest,Operation> deleteDeployPolicyCallable()

Deletes a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeployPolicyRequest request =
       DeleteDeployPolicyRequest.newBuilder()
           .setName(DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.deleteDeployPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteDeployPolicyRequest,Operation>`

deleteDeployPolicyOperationCallable()

public final OperationCallable<DeleteDeployPolicyRequest,Empty,OperationMetadata> deleteDeployPolicyOperationCallable()

Deletes a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteDeployPolicyRequest request =
       DeleteDeployPolicyRequest.newBuilder()
           .setName(DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       cloudDeployClient.deleteDeployPolicyOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteDeployPolicyRequest,Empty,OperationMetadata>`

deleteTargetAsync(@Nullable TargetName name)

public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(@Nullable TargetName name)

Deletes a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TargetName name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]");
   cloudDeployClient.deleteTargetAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.TargetName` Required. The name of the `Target` to delete. The format is `projects/{project_id}/locations/{location_name}/targets/{target_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteTargetAsync(DeleteTargetRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(DeleteTargetRequest request)

Deletes a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteTargetRequest request =
       DeleteTargetRequest.newBuilder()
           .setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   cloudDeployClient.deleteTargetAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteTargetRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteTargetAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(String name)

Deletes a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
   cloudDeployClient.deleteTargetAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the `Target` to delete. The format is `projects/{project_id}/locations/{location_name}/targets/{target_name}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteTargetCallable()

public final UnaryCallable<DeleteTargetRequest,Operation> deleteTargetCallable()

Deletes a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteTargetRequest request =
       DeleteTargetRequest.newBuilder()
           .setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = cloudDeployClient.deleteTargetCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteTargetRequest,Operation>`

deleteTargetOperationCallable()

public final OperationCallable<DeleteTargetRequest,Empty,OperationMetadata> deleteTargetOperationCallable()

Deletes a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeleteTargetRequest request =
       DeleteTargetRequest.newBuilder()
           .setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       cloudDeployClient.deleteTargetOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteTargetRequest,Empty,OperationMetadata>`

getAutomation(@Nullable AutomationName name)

public final Automation getAutomation(@Nullable AutomationName name)

Gets details of a single Automation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AutomationName name =
       AutomationName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]");
   Automation response = cloudDeployClient.getAutomation(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.AutomationName` Required. Name of the `Automation`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.

Returns
Type	Description
`Automation`

getAutomation(GetAutomationRequest request)

public final Automation getAutomation(GetAutomationRequest request)

Gets details of a single Automation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetAutomationRequest request =
       GetAutomationRequest.newBuilder()
           .setName(
               AutomationName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
                   .toString())
           .build();
   Automation response = cloudDeployClient.getAutomation(request);
 }

Parameter
Name	Description
`request`	`GetAutomationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Automation`

getAutomation(String name)

public final Automation getAutomation(String name)

Gets details of a single Automation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       AutomationName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
           .toString();
   Automation response = cloudDeployClient.getAutomation(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `Automation`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.

Returns
Type	Description
`Automation`

getAutomationCallable()

public final UnaryCallable<GetAutomationRequest,Automation> getAutomationCallable()

Gets details of a single Automation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetAutomationRequest request =
       GetAutomationRequest.newBuilder()
           .setName(
               AutomationName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION]")
                   .toString())
           .build();
   ApiFuture<Automation> future = cloudDeployClient.getAutomationCallable().futureCall(request);
   // Do something.
   Automation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAutomationRequest,Automation>`

getAutomationRun(@Nullable AutomationRunName name)

public final AutomationRun getAutomationRun(@Nullable AutomationRunName name)

Gets details of a single AutomationRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   AutomationRunName name =
       AutomationRunName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]");
   AutomationRun response = cloudDeployClient.getAutomationRun(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.AutomationRunName` Required. Name of the `AutomationRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.

Returns
Type	Description
`AutomationRun`

getAutomationRun(GetAutomationRunRequest request)

public final AutomationRun getAutomationRun(GetAutomationRunRequest request)

Gets details of a single AutomationRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetAutomationRunRequest request =
       GetAutomationRunRequest.newBuilder()
           .setName(
               AutomationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
                   .toString())
           .build();
   AutomationRun response = cloudDeployClient.getAutomationRun(request);
 }

Parameter
Name	Description
`request`	`GetAutomationRunRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AutomationRun`

getAutomationRun(String name)

public final AutomationRun getAutomationRun(String name)

Gets details of a single AutomationRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       AutomationRunName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
           .toString();
   AutomationRun response = cloudDeployClient.getAutomationRun(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `AutomationRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.

Returns
Type	Description
`AutomationRun`

getAutomationRunCallable()

public final UnaryCallable<GetAutomationRunRequest,AutomationRun> getAutomationRunCallable()

Gets details of a single AutomationRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetAutomationRunRequest request =
       GetAutomationRunRequest.newBuilder()
           .setName(
               AutomationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
                   .toString())
           .build();
   ApiFuture<AutomationRun> future =
       cloudDeployClient.getAutomationRunCallable().futureCall(request);
   // Do something.
   AutomationRun response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAutomationRunRequest,AutomationRun>`

getConfig(@Nullable ConfigName name)

public final Config getConfig(@Nullable ConfigName name)

Gets the configuration for a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ConfigName name = ConfigName.of("[PROJECT]", "[LOCATION]");
   Config response = cloudDeployClient.getConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.ConfigName` Required. Name of requested configuration.

Returns
Type	Description
`Config`

getConfig(GetConfigRequest request)

public final Config getConfig(GetConfigRequest request)

Gets the configuration for a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetConfigRequest request =
       GetConfigRequest.newBuilder()
           .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   Config response = cloudDeployClient.getConfig(request);
 }

Parameter
Name	Description
`request`	`GetConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Config`

getConfig(String name)

public final Config getConfig(String name)

Gets the configuration for a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name = ConfigName.of("[PROJECT]", "[LOCATION]").toString();
   Config response = cloudDeployClient.getConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of requested configuration.

Returns
Type	Description
`Config`

getConfigCallable()

public final UnaryCallable<GetConfigRequest,Config> getConfigCallable()

Gets the configuration for a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetConfigRequest request =
       GetConfigRequest.newBuilder()
           .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<Config> future = cloudDeployClient.getConfigCallable().futureCall(request);
   // Do something.
   Config response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetConfigRequest,Config>`

getCustomTargetType(@Nullable CustomTargetTypeName name)

public final CustomTargetType getCustomTargetType(@Nullable CustomTargetTypeName name)

Gets details of a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CustomTargetTypeName name =
       CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]");
   CustomTargetType response = cloudDeployClient.getCustomTargetType(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.CustomTargetTypeName` Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.

Returns
Type	Description
`CustomTargetType`

getCustomTargetType(GetCustomTargetTypeRequest request)

public final CustomTargetType getCustomTargetType(GetCustomTargetTypeRequest request)

Gets details of a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetCustomTargetTypeRequest request =
       GetCustomTargetTypeRequest.newBuilder()
           .setName(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .build();
   CustomTargetType response = cloudDeployClient.getCustomTargetType(request);
 }

Parameter
Name	Description
`request`	`GetCustomTargetTypeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CustomTargetType`

getCustomTargetType(String name)

public final CustomTargetType getCustomTargetType(String name)

Gets details of a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]").toString();
   CustomTargetType response = cloudDeployClient.getCustomTargetType(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.

Returns
Type	Description
`CustomTargetType`

getCustomTargetTypeCallable()

public final UnaryCallable<GetCustomTargetTypeRequest,CustomTargetType> getCustomTargetTypeCallable()

Gets details of a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetCustomTargetTypeRequest request =
       GetCustomTargetTypeRequest.newBuilder()
           .setName(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .build();
   ApiFuture<CustomTargetType> future =
       cloudDeployClient.getCustomTargetTypeCallable().futureCall(request);
   // Do something.
   CustomTargetType response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCustomTargetTypeRequest,CustomTargetType>`

getDeliveryPipeline(@Nullable DeliveryPipelineName name)

public final DeliveryPipeline getDeliveryPipeline(@Nullable DeliveryPipelineName name)

Gets details of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. Name of the `DeliveryPipeline`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`DeliveryPipeline`

getDeliveryPipeline(GetDeliveryPipelineRequest request)

public final DeliveryPipeline getDeliveryPipeline(GetDeliveryPipelineRequest request)

Gets details of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetDeliveryPipelineRequest request =
       GetDeliveryPipelineRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .build();
   DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(request);
 }

Parameter
Name	Description
`request`	`GetDeliveryPipelineRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DeliveryPipeline`

getDeliveryPipeline(String name)

public final DeliveryPipeline getDeliveryPipeline(String name)

Gets details of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `DeliveryPipeline`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`DeliveryPipeline`

getDeliveryPipelineCallable()

public final UnaryCallable<GetDeliveryPipelineRequest,DeliveryPipeline> getDeliveryPipelineCallable()

Gets details of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetDeliveryPipelineRequest request =
       GetDeliveryPipelineRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .build();
   ApiFuture<DeliveryPipeline> future =
       cloudDeployClient.getDeliveryPipelineCallable().futureCall(request);
   // Do something.
   DeliveryPipeline response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDeliveryPipelineRequest,DeliveryPipeline>`

getDeployPolicy(@Nullable DeployPolicyName name)

public final DeployPolicy getDeployPolicy(@Nullable DeployPolicyName name)

Gets details of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeployPolicyName name = DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]");
   DeployPolicy response = cloudDeployClient.getDeployPolicy(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeployPolicyName` Required. Name of the `DeployPolicy`. Format must be `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.

Returns
Type	Description
`DeployPolicy`

getDeployPolicy(GetDeployPolicyRequest request)

public final DeployPolicy getDeployPolicy(GetDeployPolicyRequest request)

Gets details of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetDeployPolicyRequest request =
       GetDeployPolicyRequest.newBuilder()
           .setName(DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString())
           .build();
   DeployPolicy response = cloudDeployClient.getDeployPolicy(request);
 }

Parameter
Name	Description
`request`	`GetDeployPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DeployPolicy`

getDeployPolicy(String name)

public final DeployPolicy getDeployPolicy(String name)

Gets details of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name = DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString();
   DeployPolicy response = cloudDeployClient.getDeployPolicy(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `DeployPolicy`. Format must be `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.

Returns
Type	Description
`DeployPolicy`

getDeployPolicyCallable()

public final UnaryCallable<GetDeployPolicyRequest,DeployPolicy> getDeployPolicyCallable()

Gets details of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetDeployPolicyRequest request =
       GetDeployPolicyRequest.newBuilder()
           .setName(DeployPolicyName.of("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]").toString())
           .build();
   ApiFuture<DeployPolicy> future =
       cloudDeployClient.getDeployPolicyCallable().futureCall(request);
   // Do something.
   DeployPolicy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDeployPolicyRequest,DeployPolicy>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = cloudDeployClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = cloudDeployClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getJobRun(@Nullable JobRunName name)

public final JobRun getJobRun(@Nullable JobRunName name)

Gets details of a single JobRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   JobRunName name =
       JobRunName.of(
           "[PROJECT]",
           "[LOCATION]",
           "[DELIVERY_PIPELINE]",
           "[RELEASE]",
           "[ROLLOUT]",
           "[JOB_RUN]");
   JobRun response = cloudDeployClient.getJobRun(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.JobRunName` Required. Name of the `JobRun`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.

Returns
Type	Description
`JobRun`

getJobRun(GetJobRunRequest request)

public final JobRun getJobRun(GetJobRunRequest request)

Gets details of a single JobRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetJobRunRequest request =
       GetJobRunRequest.newBuilder()
           .setName(
               JobRunName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]",
                       "[JOB_RUN]")
                   .toString())
           .build();
   JobRun response = cloudDeployClient.getJobRun(request);
 }

Parameter
Name	Description
`request`	`GetJobRunRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`JobRun`

getJobRun(String name)

public final JobRun getJobRun(String name)

Gets details of a single JobRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       JobRunName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[DELIVERY_PIPELINE]",
               "[RELEASE]",
               "[ROLLOUT]",
               "[JOB_RUN]")
           .toString();
   JobRun response = cloudDeployClient.getJobRun(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `JobRun`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.

Returns
Type	Description
`JobRun`

getJobRunCallable()

public final UnaryCallable<GetJobRunRequest,JobRun> getJobRunCallable()

Gets details of a single JobRun.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetJobRunRequest request =
       GetJobRunRequest.newBuilder()
           .setName(
               JobRunName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]",
                       "[JOB_RUN]")
                   .toString())
           .build();
   ApiFuture<JobRun> future = cloudDeployClient.getJobRunCallable().futureCall(request);
   // Do something.
   JobRun response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetJobRunRequest,JobRun>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = cloudDeployClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = cloudDeployClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getRelease(@Nullable ReleaseName name)

public final Release getRelease(@Nullable ReleaseName name)

Gets details of a single Release.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ReleaseName name =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
   Release response = cloudDeployClient.getRelease(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.ReleaseName` Required. Name of the `Release`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.

Returns
Type	Description
`Release`

getRelease(GetReleaseRequest request)

public final Release getRelease(GetReleaseRequest request)

Gets details of a single Release.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetReleaseRequest request =
       GetReleaseRequest.newBuilder()
           .setName(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .build();
   Release response = cloudDeployClient.getRelease(request);
 }

Parameter
Name	Description
`request`	`GetReleaseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Release`

getRelease(String name)

public final Release getRelease(String name)

Gets details of a single Release.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
   Release response = cloudDeployClient.getRelease(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `Release`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.

Returns
Type	Description
`Release`

getReleaseCallable()

public final UnaryCallable<GetReleaseRequest,Release> getReleaseCallable()

Gets details of a single Release.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetReleaseRequest request =
       GetReleaseRequest.newBuilder()
           .setName(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .build();
   ApiFuture<Release> future = cloudDeployClient.getReleaseCallable().futureCall(request);
   // Do something.
   Release response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetReleaseRequest,Release>`

getRollout(@Nullable RolloutName name)

public final Rollout getRollout(@Nullable RolloutName name)

Gets details of a single Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName name =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   Rollout response = cloudDeployClient.getRollout(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the `Rollout`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`.

Returns
Type	Description
`Rollout`

getRollout(GetRolloutRequest request)

public final Rollout getRollout(GetRolloutRequest request)

Gets details of a single Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetRolloutRequest request =
       GetRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .build();
   Rollout response = cloudDeployClient.getRollout(request);
 }

Parameter
Name	Description
`request`	`GetRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Rollout`

getRollout(String name)

public final Rollout getRollout(String name)

Gets details of a single Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   Rollout response = cloudDeployClient.getRollout(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `Rollout`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`.

Returns
Type	Description
`Rollout`

getRolloutCallable()

public final UnaryCallable<GetRolloutRequest,Rollout> getRolloutCallable()

Gets details of a single Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetRolloutRequest request =
       GetRolloutRequest.newBuilder()
           .setName(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .build();
   ApiFuture<Rollout> future = cloudDeployClient.getRolloutCallable().futureCall(request);
   // Do something.
   Rollout response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRolloutRequest,Rollout>`

getSettings()

public final @Nullable CloudDeploySettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.CloudDeploySettings`

getStub()

public CloudDeployStub getStub()

Returns
Type	Description
`CloudDeployStub`

getTarget(@Nullable TargetName name)

public final Target getTarget(@Nullable TargetName name)

Gets details of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TargetName name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]");
   Target response = cloudDeployClient.getTarget(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.TargetName` Required. Name of the `Target`. Format must be `projects/{project_id}/locations/{location_name}/targets/{target_name}`.

Returns
Type	Description
`Target`

getTarget(GetTargetRequest request)

public final Target getTarget(GetTargetRequest request)

Gets details of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetTargetRequest request =
       GetTargetRequest.newBuilder()
           .setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
           .build();
   Target response = cloudDeployClient.getTarget(request);
 }

Parameter
Name	Description
`request`	`GetTargetRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Target`

getTarget(String name)

public final Target getTarget(String name)

Gets details of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
   Target response = cloudDeployClient.getTarget(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `Target`. Format must be `projects/{project_id}/locations/{location_name}/targets/{target_name}`.

Returns
Type	Description
`Target`

getTargetCallable()

public final UnaryCallable<GetTargetRequest,Target> getTargetCallable()

Gets details of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   GetTargetRequest request =
       GetTargetRequest.newBuilder()
           .setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
           .build();
   ApiFuture<Target> future = cloudDeployClient.getTargetCallable().futureCall(request);
   // Do something.
   Target response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetTargetRequest,Target>`

ignoreJob(@Nullable RolloutName rollout, String phaseId, String jobId)

public final IgnoreJobResponse ignoreJob(@Nullable RolloutName rollout, String phaseId, String jobId)

Ignores the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName rollout =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   String phaseId = "phaseId-608264202";
   String jobId = "jobId101296568";
   IgnoreJobResponse response = cloudDeployClient.ignoreJob(rollout, phaseId, jobId);
 }

Parameters
Name	Description
`rollout`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID the Job to ignore belongs to.
`jobId`	`String` Required. The job ID for the Job to ignore.

Returns
Type	Description
`IgnoreJobResponse`

ignoreJob(IgnoreJobRequest request)

public final IgnoreJobResponse ignoreJob(IgnoreJobRequest request)

Ignores the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   IgnoreJobRequest request =
       IgnoreJobRequest.newBuilder()
           .setRollout(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .setJobId("jobId101296568")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   IgnoreJobResponse response = cloudDeployClient.ignoreJob(request);
 }

Parameter
Name	Description
`request`	`IgnoreJobRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`IgnoreJobResponse`

ignoreJob(String rollout, String phaseId, String jobId)

public final IgnoreJobResponse ignoreJob(String rollout, String phaseId, String jobId)

Ignores the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String rollout =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   String phaseId = "phaseId-608264202";
   String jobId = "jobId101296568";
   IgnoreJobResponse response = cloudDeployClient.ignoreJob(rollout, phaseId, jobId);
 }

Parameters
Name	Description
`rollout`	`String` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID the Job to ignore belongs to.
`jobId`	`String` Required. The job ID for the Job to ignore.

Returns
Type	Description
`IgnoreJobResponse`

ignoreJobCallable()

public final UnaryCallable<IgnoreJobRequest,IgnoreJobResponse> ignoreJobCallable()

Ignores the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   IgnoreJobRequest request =
       IgnoreJobRequest.newBuilder()
           .setRollout(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .setJobId("jobId101296568")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<IgnoreJobResponse> future =
       cloudDeployClient.ignoreJobCallable().futureCall(request);
   // Do something.
   IgnoreJobResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<IgnoreJobRequest,IgnoreJobResponse>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAutomationRuns(@Nullable DeliveryPipelineName parent)

public final CloudDeployClient.ListAutomationRunsPagedResponse listAutomationRuns(@Nullable DeliveryPipelineName parent)

Lists AutomationRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   for (AutomationRun element : cloudDeployClient.listAutomationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.

Returns
Type	Description
`CloudDeployClient.ListAutomationRunsPagedResponse`

listAutomationRuns(ListAutomationRunsRequest request)

public final CloudDeployClient.ListAutomationRunsPagedResponse listAutomationRuns(ListAutomationRunsRequest request)

Lists AutomationRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationRunsRequest request =
       ListAutomationRunsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (AutomationRun element : cloudDeployClient.listAutomationRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAutomationRunsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListAutomationRunsPagedResponse`

listAutomationRuns(String parent)

public final CloudDeployClient.ListAutomationRunsPagedResponse listAutomationRuns(String parent)

Lists AutomationRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   for (AutomationRun element : cloudDeployClient.listAutomationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.

Returns
Type	Description
`CloudDeployClient.ListAutomationRunsPagedResponse`

listAutomationRunsCallable()

public final UnaryCallable<ListAutomationRunsRequest,ListAutomationRunsResponse> listAutomationRunsCallable()

Lists AutomationRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationRunsRequest request =
       ListAutomationRunsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAutomationRunsResponse response =
         cloudDeployClient.listAutomationRunsCallable().call(request);
     for (AutomationRun element : response.getAutomationRunsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAutomationRunsRequest,ListAutomationRunsResponse>`

listAutomationRunsPagedCallable()

public final UnaryCallable<ListAutomationRunsRequest,CloudDeployClient.ListAutomationRunsPagedResponse> listAutomationRunsPagedCallable()

Lists AutomationRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationRunsRequest request =
       ListAutomationRunsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<AutomationRun> future =
       cloudDeployClient.listAutomationRunsPagedCallable().futureCall(request);
   // Do something.
   for (AutomationRun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAutomationRunsRequest,ListAutomationRunsPagedResponse>`

listAutomations(@Nullable DeliveryPipelineName parent)

public final CloudDeployClient.ListAutomationsPagedResponse listAutomations(@Nullable DeliveryPipelineName parent)

Lists Automations in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   for (Automation element : cloudDeployClient.listAutomations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`CloudDeployClient.ListAutomationsPagedResponse`

listAutomations(ListAutomationsRequest request)

public final CloudDeployClient.ListAutomationsPagedResponse listAutomations(ListAutomationsRequest request)

Lists Automations in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationsRequest request =
       ListAutomationsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Automation element : cloudDeployClient.listAutomations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAutomationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListAutomationsPagedResponse`

listAutomations(String parent)

public final CloudDeployClient.ListAutomationsPagedResponse listAutomations(String parent)

Lists Automations in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   for (Automation element : cloudDeployClient.listAutomations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.

Returns
Type	Description
`CloudDeployClient.ListAutomationsPagedResponse`

listAutomationsCallable()

public final UnaryCallable<ListAutomationsRequest,ListAutomationsResponse> listAutomationsCallable()

Lists Automations in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationsRequest request =
       ListAutomationsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAutomationsResponse response =
         cloudDeployClient.listAutomationsCallable().call(request);
     for (Automation element : response.getAutomationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAutomationsRequest,ListAutomationsResponse>`

listAutomationsPagedCallable()

public final UnaryCallable<ListAutomationsRequest,CloudDeployClient.ListAutomationsPagedResponse> listAutomationsPagedCallable()

Lists Automations in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListAutomationsRequest request =
       ListAutomationsRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Automation> future =
       cloudDeployClient.listAutomationsPagedCallable().futureCall(request);
   // Do something.
   for (Automation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAutomationsRequest,ListAutomationsPagedResponse>`

listCustomTargetTypes(@Nullable LocationName parent)

public final CloudDeployClient.ListCustomTargetTypesPagedResponse listCustomTargetTypes(@Nullable LocationName parent)

Lists CustomTargetTypes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (CustomTargetType element :
       cloudDeployClient.listCustomTargetTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListCustomTargetTypesPagedResponse`

listCustomTargetTypes(ListCustomTargetTypesRequest request)

public final CloudDeployClient.ListCustomTargetTypesPagedResponse listCustomTargetTypes(ListCustomTargetTypesRequest request)

Lists CustomTargetTypes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListCustomTargetTypesRequest request =
       ListCustomTargetTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (CustomTargetType element :
       cloudDeployClient.listCustomTargetTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCustomTargetTypesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListCustomTargetTypesPagedResponse`

listCustomTargetTypes(String parent)

public final CloudDeployClient.ListCustomTargetTypesPagedResponse listCustomTargetTypes(String parent)

Lists CustomTargetTypes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (CustomTargetType element :
       cloudDeployClient.listCustomTargetTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListCustomTargetTypesPagedResponse`

listCustomTargetTypesCallable()

public final UnaryCallable<ListCustomTargetTypesRequest,ListCustomTargetTypesResponse> listCustomTargetTypesCallable()

Lists CustomTargetTypes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListCustomTargetTypesRequest request =
       ListCustomTargetTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListCustomTargetTypesResponse response =
         cloudDeployClient.listCustomTargetTypesCallable().call(request);
     for (CustomTargetType element : response.getCustomTargetTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCustomTargetTypesRequest,ListCustomTargetTypesResponse>`

listCustomTargetTypesPagedCallable()

public final UnaryCallable<ListCustomTargetTypesRequest,CloudDeployClient.ListCustomTargetTypesPagedResponse> listCustomTargetTypesPagedCallable()

Lists CustomTargetTypes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListCustomTargetTypesRequest request =
       ListCustomTargetTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<CustomTargetType> future =
       cloudDeployClient.listCustomTargetTypesPagedCallable().futureCall(request);
   // Do something.
   for (CustomTargetType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCustomTargetTypesRequest,ListCustomTargetTypesPagedResponse>`

listDeliveryPipelines(@Nullable LocationName parent)

public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(@Nullable LocationName parent)

Lists DeliveryPipelines in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DeliveryPipeline element :
       cloudDeployClient.listDeliveryPipelines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent, which owns this collection of pipelines. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListDeliveryPipelinesPagedResponse`

listDeliveryPipelines(ListDeliveryPipelinesRequest request)

public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(ListDeliveryPipelinesRequest request)

Lists DeliveryPipelines in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeliveryPipelinesRequest request =
       ListDeliveryPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DeliveryPipeline element :
       cloudDeployClient.listDeliveryPipelines(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListDeliveryPipelinesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListDeliveryPipelinesPagedResponse`

listDeliveryPipelines(String parent)

public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(String parent)

Lists DeliveryPipelines in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DeliveryPipeline element :
       cloudDeployClient.listDeliveryPipelines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of pipelines. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListDeliveryPipelinesPagedResponse`

listDeliveryPipelinesCallable()

public final UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse> listDeliveryPipelinesCallable()

Lists DeliveryPipelines in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeliveryPipelinesRequest request =
       ListDeliveryPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDeliveryPipelinesResponse response =
         cloudDeployClient.listDeliveryPipelinesCallable().call(request);
     for (DeliveryPipeline element : response.getDeliveryPipelinesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse>`

listDeliveryPipelinesPagedCallable()

public final UnaryCallable<ListDeliveryPipelinesRequest,CloudDeployClient.ListDeliveryPipelinesPagedResponse> listDeliveryPipelinesPagedCallable()

Lists DeliveryPipelines in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeliveryPipelinesRequest request =
       ListDeliveryPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DeliveryPipeline> future =
       cloudDeployClient.listDeliveryPipelinesPagedCallable().futureCall(request);
   // Do something.
   for (DeliveryPipeline element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesPagedResponse>`

listDeployPolicies(@Nullable LocationName parent)

public final CloudDeployClient.ListDeployPoliciesPagedResponse listDeployPolicies(@Nullable LocationName parent)

Lists DeployPolicies in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DeployPolicy element : cloudDeployClient.listDeployPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListDeployPoliciesPagedResponse`

listDeployPolicies(ListDeployPoliciesRequest request)

public final CloudDeployClient.ListDeployPoliciesPagedResponse listDeployPolicies(ListDeployPoliciesRequest request)

Lists DeployPolicies in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeployPoliciesRequest request =
       ListDeployPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DeployPolicy element : cloudDeployClient.listDeployPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListDeployPoliciesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListDeployPoliciesPagedResponse`

listDeployPolicies(String parent)

public final CloudDeployClient.ListDeployPoliciesPagedResponse listDeployPolicies(String parent)

Lists DeployPolicies in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DeployPolicy element : cloudDeployClient.listDeployPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListDeployPoliciesPagedResponse`

listDeployPoliciesCallable()

public final UnaryCallable<ListDeployPoliciesRequest,ListDeployPoliciesResponse> listDeployPoliciesCallable()

Lists DeployPolicies in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeployPoliciesRequest request =
       ListDeployPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDeployPoliciesResponse response =
         cloudDeployClient.listDeployPoliciesCallable().call(request);
     for (DeployPolicy element : response.getDeployPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListDeployPoliciesRequest,ListDeployPoliciesResponse>`

listDeployPoliciesPagedCallable()

public final UnaryCallable<ListDeployPoliciesRequest,CloudDeployClient.ListDeployPoliciesPagedResponse> listDeployPoliciesPagedCallable()

Lists DeployPolicies in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListDeployPoliciesRequest request =
       ListDeployPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DeployPolicy> future =
       cloudDeployClient.listDeployPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (DeployPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListDeployPoliciesRequest,ListDeployPoliciesPagedResponse>`

listJobRuns(@Nullable RolloutName parent)

public final CloudDeployClient.ListJobRunsPagedResponse listJobRuns(@Nullable RolloutName parent)

Lists JobRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName parent =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   for (JobRun element : cloudDeployClient.listJobRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. The `Rollout` which owns this collection of `JobRun` objects.

Returns
Type	Description
`CloudDeployClient.ListJobRunsPagedResponse`

listJobRuns(ListJobRunsRequest request)

public final CloudDeployClient.ListJobRunsPagedResponse listJobRuns(ListJobRunsRequest request)

Lists JobRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListJobRunsRequest request =
       ListJobRunsRequest.newBuilder()
           .setParent(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (JobRun element : cloudDeployClient.listJobRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListJobRunsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListJobRunsPagedResponse`

listJobRuns(String parent)

public final CloudDeployClient.ListJobRunsPagedResponse listJobRuns(String parent)

Lists JobRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   for (JobRun element : cloudDeployClient.listJobRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The `Rollout` which owns this collection of `JobRun` objects.

Returns
Type	Description
`CloudDeployClient.ListJobRunsPagedResponse`

listJobRunsCallable()

public final UnaryCallable<ListJobRunsRequest,ListJobRunsResponse> listJobRunsCallable()

Lists JobRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListJobRunsRequest request =
       ListJobRunsRequest.newBuilder()
           .setParent(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListJobRunsResponse response = cloudDeployClient.listJobRunsCallable().call(request);
     for (JobRun element : response.getJobRunsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListJobRunsRequest,ListJobRunsResponse>`

listJobRunsPagedCallable()

public final UnaryCallable<ListJobRunsRequest,CloudDeployClient.ListJobRunsPagedResponse> listJobRunsPagedCallable()

Lists JobRuns in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListJobRunsRequest request =
       ListJobRunsRequest.newBuilder()
           .setParent(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<JobRun> future = cloudDeployClient.listJobRunsPagedCallable().futureCall(request);
   // Do something.
   for (JobRun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListJobRunsRequest,ListJobRunsPagedResponse>`

listLocations(ListLocationsRequest request)

public final CloudDeployClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : cloudDeployClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = cloudDeployClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,CloudDeployClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       cloudDeployClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listReleases(@Nullable DeliveryPipelineName parent)

public final CloudDeployClient.ListReleasesPagedResponse listReleases(@Nullable DeliveryPipelineName parent)

Lists Releases in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   for (Release element : cloudDeployClient.listReleases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The `DeliveryPipeline` which owns this collection of `Release` objects.

Returns
Type	Description
`CloudDeployClient.ListReleasesPagedResponse`

listReleases(ListReleasesRequest request)

public final CloudDeployClient.ListReleasesPagedResponse listReleases(ListReleasesRequest request)

Lists Releases in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListReleasesRequest request =
       ListReleasesRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Release element : cloudDeployClient.listReleases(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListReleasesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListReleasesPagedResponse`

listReleases(String parent)

public final CloudDeployClient.ListReleasesPagedResponse listReleases(String parent)

Lists Releases in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   for (Release element : cloudDeployClient.listReleases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The `DeliveryPipeline` which owns this collection of `Release` objects.

Returns
Type	Description
`CloudDeployClient.ListReleasesPagedResponse`

listReleasesCallable()

public final UnaryCallable<ListReleasesRequest,ListReleasesResponse> listReleasesCallable()

Lists Releases in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListReleasesRequest request =
       ListReleasesRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListReleasesResponse response = cloudDeployClient.listReleasesCallable().call(request);
     for (Release element : response.getReleasesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListReleasesRequest,ListReleasesResponse>`

listReleasesPagedCallable()

public final UnaryCallable<ListReleasesRequest,CloudDeployClient.ListReleasesPagedResponse> listReleasesPagedCallable()

Lists Releases in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListReleasesRequest request =
       ListReleasesRequest.newBuilder()
           .setParent(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Release> future = cloudDeployClient.listReleasesPagedCallable().futureCall(request);
   // Do something.
   for (Release element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListReleasesRequest,ListReleasesPagedResponse>`

listRollouts(@Nullable ReleaseName parent)

public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(@Nullable ReleaseName parent)

Lists Rollouts in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ReleaseName parent =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
   for (Rollout element : cloudDeployClient.listRollouts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.ReleaseName` Required. The `Release` which owns this collection of `Rollout` objects.

Returns
Type	Description
`CloudDeployClient.ListRolloutsPagedResponse`

listRollouts(ListRolloutsRequest request)

public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(ListRolloutsRequest request)

Lists Rollouts in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Rollout element : cloudDeployClient.listRollouts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRolloutsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListRolloutsPagedResponse`

listRollouts(String parent)

public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(String parent)

Lists Rollouts in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent =
       ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
   for (Rollout element : cloudDeployClient.listRollouts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The `Release` which owns this collection of `Rollout` objects.

Returns
Type	Description
`CloudDeployClient.ListRolloutsPagedResponse`

listRolloutsCallable()

public final UnaryCallable<ListRolloutsRequest,ListRolloutsResponse> listRolloutsCallable()

Lists Rollouts in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRolloutsResponse response = cloudDeployClient.listRolloutsCallable().call(request);
     for (Rollout element : response.getRolloutsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutsRequest,ListRolloutsResponse>`

listRolloutsPagedCallable()

public final UnaryCallable<ListRolloutsRequest,CloudDeployClient.ListRolloutsPagedResponse> listRolloutsPagedCallable()

Lists Rollouts in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(
               ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Rollout> future = cloudDeployClient.listRolloutsPagedCallable().futureCall(request);
   // Do something.
   for (Rollout element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutsRequest,ListRolloutsPagedResponse>`

listTargets(@Nullable LocationName parent)

public final CloudDeployClient.ListTargetsPagedResponse listTargets(@Nullable LocationName parent)

Lists Targets in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Target element : cloudDeployClient.listTargets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.LocationName` Required. The parent, which owns this collection of targets. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListTargetsPagedResponse`

listTargets(ListTargetsRequest request)

public final CloudDeployClient.ListTargetsPagedResponse listTargets(ListTargetsRequest request)

Lists Targets in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListTargetsRequest request =
       ListTargetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Target element : cloudDeployClient.listTargets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListTargetsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudDeployClient.ListTargetsPagedResponse`

listTargets(String parent)

public final CloudDeployClient.ListTargetsPagedResponse listTargets(String parent)

Lists Targets in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Target element : cloudDeployClient.listTargets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of targets. Format must be `projects/{project_id}/locations/{location_name}`.

Returns
Type	Description
`CloudDeployClient.ListTargetsPagedResponse`

listTargetsCallable()

public final UnaryCallable<ListTargetsRequest,ListTargetsResponse> listTargetsCallable()

Lists Targets in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListTargetsRequest request =
       ListTargetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListTargetsResponse response = cloudDeployClient.listTargetsCallable().call(request);
     for (Target element : response.getTargetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListTargetsRequest,ListTargetsResponse>`

listTargetsPagedCallable()

public final UnaryCallable<ListTargetsRequest,CloudDeployClient.ListTargetsPagedResponse> listTargetsPagedCallable()

Lists Targets in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   ListTargetsRequest request =
       ListTargetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Target> future = cloudDeployClient.listTargetsPagedCallable().futureCall(request);
   // Do something.
   for (Target element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListTargetsRequest,ListTargetsPagedResponse>`

retryJob(@Nullable RolloutName rollout, String phaseId, String jobId)

public final RetryJobResponse retryJob(@Nullable RolloutName rollout, String phaseId, String jobId)

Retries the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RolloutName rollout =
       RolloutName.of(
           "[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
   String phaseId = "phaseId-608264202";
   String jobId = "jobId101296568";
   RetryJobResponse response = cloudDeployClient.retryJob(rollout, phaseId, jobId);
 }

Parameters
Name	Description
`rollout`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.RolloutName` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID the Job to retry belongs to.
`jobId`	`String` Required. The job ID for the Job to retry.

Returns
Type	Description
`RetryJobResponse`

retryJob(RetryJobRequest request)

public final RetryJobResponse retryJob(RetryJobRequest request)

Retries the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RetryJobRequest request =
       RetryJobRequest.newBuilder()
           .setRollout(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .setJobId("jobId101296568")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   RetryJobResponse response = cloudDeployClient.retryJob(request);
 }

Parameter
Name	Description
`request`	`RetryJobRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RetryJobResponse`

retryJob(String rollout, String phaseId, String jobId)

public final RetryJobResponse retryJob(String rollout, String phaseId, String jobId)

Retries the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String rollout =
       RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
           .toString();
   String phaseId = "phaseId-608264202";
   String jobId = "jobId101296568";
   RetryJobResponse response = cloudDeployClient.retryJob(rollout, phaseId, jobId);
 }

Parameters
Name	Description
`rollout`	`String` Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
`phaseId`	`String` Required. The phase ID the Job to retry belongs to.
`jobId`	`String` Required. The job ID for the Job to retry.

Returns
Type	Description
`RetryJobResponse`

retryJobCallable()

public final UnaryCallable<RetryJobRequest,RetryJobResponse> retryJobCallable()

Retries the specified Job in a Rollout.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RetryJobRequest request =
       RetryJobRequest.newBuilder()
           .setRollout(
               RolloutName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]")
                   .toString())
           .setPhaseId("phaseId-608264202")
           .setJobId("jobId101296568")
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<RetryJobResponse> future = cloudDeployClient.retryJobCallable().futureCall(request);
   // Do something.
   RetryJobResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RetryJobRequest,RetryJobResponse>`

rollbackTarget(@Nullable DeliveryPipelineName name, String targetId, String rolloutId)

public final RollbackTargetResponse rollbackTarget(@Nullable DeliveryPipelineName name, String targetId, String rolloutId)

Creates a Rollout to roll back the specified target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipelineName name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
   String targetId = "targetId-441951604";
   String rolloutId = "rolloutId551248556";
   RollbackTargetResponse response = cloudDeployClient.rollbackTarget(name, targetId, rolloutId);
 }

Parameters
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.DeliveryPipelineName` Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`targetId`	`String` Required. ID of the `Target` that is being rolled back.
`rolloutId`	`String` Required. ID of the rollback `Rollout` to create.

Returns
Type	Description
`RollbackTargetResponse`

rollbackTarget(RollbackTargetRequest request)

public final RollbackTargetResponse rollbackTarget(RollbackTargetRequest request)

Creates a Rollout to roll back the specified target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RollbackTargetRequest request =
       RollbackTargetRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setTargetId("targetId-441951604")
           .setRolloutId("rolloutId551248556")
           .setReleaseId("releaseId89607042")
           .setRolloutToRollBack("rolloutToRollBack-1195544784")
           .setRollbackConfig(RollbackTargetConfig.newBuilder().build())
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   RollbackTargetResponse response = cloudDeployClient.rollbackTarget(request);
 }

Parameter
Name	Description
`request`	`RollbackTargetRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RollbackTargetResponse`

rollbackTarget(String name, String targetId, String rolloutId)

public final RollbackTargetResponse rollbackTarget(String name, String targetId, String rolloutId)

Creates a Rollout to roll back the specified target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
   String targetId = "targetId-441951604";
   String rolloutId = "rolloutId551248556";
   RollbackTargetResponse response = cloudDeployClient.rollbackTarget(name, targetId, rolloutId);
 }

Parameters
Name	Description
`name`	`String` Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`targetId`	`String` Required. ID of the `Target` that is being rolled back.
`rolloutId`	`String` Required. ID of the rollback `Rollout` to create.

Returns
Type	Description
`RollbackTargetResponse`

rollbackTargetCallable()

public final UnaryCallable<RollbackTargetRequest,RollbackTargetResponse> rollbackTargetCallable()

Creates a Rollout to roll back the specified target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   RollbackTargetRequest request =
       RollbackTargetRequest.newBuilder()
           .setName(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .setTargetId("targetId-441951604")
           .setRolloutId("rolloutId551248556")
           .setReleaseId("releaseId89607042")
           .setRolloutToRollBack("rolloutToRollBack-1195544784")
           .setRollbackConfig(RollbackTargetConfig.newBuilder().build())
           .setValidateOnly(true)
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<RollbackTargetResponse> future =
       cloudDeployClient.rollbackTargetCallable().futureCall(request);
   // Do something.
   RollbackTargetResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RollbackTargetRequest,RollbackTargetResponse>`

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = cloudDeployClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               CustomTargetTypeName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_TARGET_TYPE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = cloudDeployClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

terminateJobRun(@Nullable JobRunName name)

public final TerminateJobRunResponse terminateJobRun(@Nullable JobRunName name)

Terminates a Job Run in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   JobRunName name =
       JobRunName.of(
           "[PROJECT]",
           "[LOCATION]",
           "[DELIVERY_PIPELINE]",
           "[RELEASE]",
           "[ROLLOUT]",
           "[JOB_RUN]");
   TerminateJobRunResponse response = cloudDeployClient.terminateJobRun(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.deploy.v1.JobRunName` Required. Name of the `JobRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.

Returns
Type	Description
`TerminateJobRunResponse`

terminateJobRun(TerminateJobRunRequest request)

public final TerminateJobRunResponse terminateJobRun(TerminateJobRunRequest request)

Terminates a Job Run in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TerminateJobRunRequest request =
       TerminateJobRunRequest.newBuilder()
           .setName(
               JobRunName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]",
                       "[JOB_RUN]")
                   .toString())
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   TerminateJobRunResponse response = cloudDeployClient.terminateJobRun(request);
 }

Parameter
Name	Description
`request`	`TerminateJobRunRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TerminateJobRunResponse`

terminateJobRun(String name)

public final TerminateJobRunResponse terminateJobRun(String name)

Terminates a Job Run in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   String name =
       JobRunName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[DELIVERY_PIPELINE]",
               "[RELEASE]",
               "[ROLLOUT]",
               "[JOB_RUN]")
           .toString();
   TerminateJobRunResponse response = cloudDeployClient.terminateJobRun(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the `JobRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.

Returns
Type	Description
`TerminateJobRunResponse`

terminateJobRunCallable()

public final UnaryCallable<TerminateJobRunRequest,TerminateJobRunResponse> terminateJobRunCallable()

Terminates a Job Run in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TerminateJobRunRequest request =
       TerminateJobRunRequest.newBuilder()
           .setName(
               JobRunName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[DELIVERY_PIPELINE]",
                       "[RELEASE]",
                       "[ROLLOUT]",
                       "[JOB_RUN]")
                   .toString())
           .addAllOverrideDeployPolicy(new ArrayList<String>())
           .build();
   ApiFuture<TerminateJobRunResponse> future =
       cloudDeployClient.terminateJobRunCallable().futureCall(request);
   // Do something.
   TerminateJobRunResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<TerminateJobRunRequest,TerminateJobRunResponse>`

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = cloudDeployClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       cloudDeployClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

updateAutomationAsync(Automation automation, FieldMask updateMask)

public final OperationFuture<Automation,OperationMetadata> updateAutomationAsync(Automation automation, FieldMask updateMask)

Updates the parameters of a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   Automation automation = Automation.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Automation response = cloudDeployClient.updateAutomationAsync(automation, updateMask).get();
 }

Parameters
Name	Description
`automation`	`Automation` Required. The `Automation` to update.
`updateMask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the `Automation` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type	Description
`OperationFuture<Automation,OperationMetadata>`

updateAutomationAsync(UpdateAutomationRequest request)

public final OperationFuture<Automation,OperationMetadata> updateAutomationAsync(UpdateAutomationRequest request)

Updates the parameters of a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateAutomationRequest request =
       UpdateAutomationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   Automation response = cloudDeployClient.updateAutomationAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateAutomationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Automation,OperationMetadata>`

updateAutomationCallable()

public final UnaryCallable<UpdateAutomationRequest,Operation> updateAutomationCallable()

Updates the parameters of a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateAutomationRequest request =
       UpdateAutomationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.updateAutomationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateAutomationRequest,Operation>`

updateAutomationOperationCallable()

public final OperationCallable<UpdateAutomationRequest,Automation,OperationMetadata> updateAutomationOperationCallable()

Updates the parameters of a single Automation resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateAutomationRequest request =
       UpdateAutomationRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAutomation(Automation.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<Automation, OperationMetadata> future =
       cloudDeployClient.updateAutomationOperationCallable().futureCall(request);
   // Do something.
   Automation response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateAutomationRequest,Automation,OperationMetadata>`

updateCustomTargetTypeAsync(CustomTargetType customTargetType, FieldMask updateMask)

public final OperationFuture<CustomTargetType,OperationMetadata> updateCustomTargetTypeAsync(CustomTargetType customTargetType, FieldMask updateMask)

Updates a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   CustomTargetType customTargetType = CustomTargetType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CustomTargetType response =
       cloudDeployClient.updateCustomTargetTypeAsync(customTargetType, updateMask).get();
 }

Parameters
Name	Description
`customTargetType`	`CustomTargetType` Required. The `CustomTargetType` to update.
`updateMask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the `CustomTargetType` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type	Description
`OperationFuture<CustomTargetType,OperationMetadata>`

updateCustomTargetTypeAsync(UpdateCustomTargetTypeRequest request)

public final OperationFuture<CustomTargetType,OperationMetadata> updateCustomTargetTypeAsync(UpdateCustomTargetTypeRequest request)

Updates a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateCustomTargetTypeRequest request =
       UpdateCustomTargetTypeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   CustomTargetType response = cloudDeployClient.updateCustomTargetTypeAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateCustomTargetTypeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<CustomTargetType,OperationMetadata>`

updateCustomTargetTypeCallable()

public final UnaryCallable<UpdateCustomTargetTypeRequest,Operation> updateCustomTargetTypeCallable()

Updates a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateCustomTargetTypeRequest request =
       UpdateCustomTargetTypeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.updateCustomTargetTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateCustomTargetTypeRequest,Operation>`

updateCustomTargetTypeOperationCallable()

public final OperationCallable<UpdateCustomTargetTypeRequest,CustomTargetType,OperationMetadata> updateCustomTargetTypeOperationCallable()

Updates a single CustomTargetType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateCustomTargetTypeRequest request =
       UpdateCustomTargetTypeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCustomTargetType(CustomTargetType.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<CustomTargetType, OperationMetadata> future =
       cloudDeployClient.updateCustomTargetTypeOperationCallable().futureCall(request);
   // Do something.
   CustomTargetType response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateCustomTargetTypeRequest,CustomTargetType,OperationMetadata>`

updateDeliveryPipelineAsync(DeliveryPipeline deliveryPipeline, FieldMask updateMask)

public final OperationFuture<DeliveryPipeline,OperationMetadata> updateDeliveryPipelineAsync(DeliveryPipeline deliveryPipeline, FieldMask updateMask)

Updates the parameters of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeliveryPipeline deliveryPipeline = DeliveryPipeline.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DeliveryPipeline response =
       cloudDeployClient.updateDeliveryPipelineAsync(deliveryPipeline, updateMask).get();
 }

Parameters
Name	Description
`deliveryPipeline`	`DeliveryPipeline` Required. The `DeliveryPipeline` to update.
`updateMask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the `DeliveryPipeline` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type	Description
`OperationFuture<DeliveryPipeline,OperationMetadata>`

updateDeliveryPipelineAsync(UpdateDeliveryPipelineRequest request)

public final OperationFuture<DeliveryPipeline,OperationMetadata> updateDeliveryPipelineAsync(UpdateDeliveryPipelineRequest request)

Updates the parameters of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeliveryPipelineRequest request =
       UpdateDeliveryPipelineRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   DeliveryPipeline response = cloudDeployClient.updateDeliveryPipelineAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateDeliveryPipelineRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<DeliveryPipeline,OperationMetadata>`

updateDeliveryPipelineCallable()

public final UnaryCallable<UpdateDeliveryPipelineRequest,Operation> updateDeliveryPipelineCallable()

Updates the parameters of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeliveryPipelineRequest request =
       UpdateDeliveryPipelineRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.updateDeliveryPipelineCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateDeliveryPipelineRequest,Operation>`

updateDeliveryPipelineOperationCallable()

public final OperationCallable<UpdateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata> updateDeliveryPipelineOperationCallable()

Updates the parameters of a single DeliveryPipeline.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeliveryPipelineRequest request =
       UpdateDeliveryPipelineRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<DeliveryPipeline, OperationMetadata> future =
       cloudDeployClient.updateDeliveryPipelineOperationCallable().futureCall(request);
   // Do something.
   DeliveryPipeline response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata>`

updateDeployPolicyAsync(DeployPolicy deployPolicy, FieldMask updateMask)

public final OperationFuture<DeployPolicy,OperationMetadata> updateDeployPolicyAsync(DeployPolicy deployPolicy, FieldMask updateMask)

Updates the parameters of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   DeployPolicy deployPolicy = DeployPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DeployPolicy response =
       cloudDeployClient.updateDeployPolicyAsync(deployPolicy, updateMask).get();
 }

Parameters
Name	Description
`deployPolicy`	`DeployPolicy` Required. The `DeployPolicy` to update.
`updateMask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the `DeployPolicy` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type	Description
`OperationFuture<DeployPolicy,OperationMetadata>`

updateDeployPolicyAsync(UpdateDeployPolicyRequest request)

public final OperationFuture<DeployPolicy,OperationMetadata> updateDeployPolicyAsync(UpdateDeployPolicyRequest request)

Updates the parameters of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeployPolicyRequest request =
       UpdateDeployPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   DeployPolicy response = cloudDeployClient.updateDeployPolicyAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateDeployPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<DeployPolicy,OperationMetadata>`

updateDeployPolicyCallable()

public final UnaryCallable<UpdateDeployPolicyRequest,Operation> updateDeployPolicyCallable()

Updates the parameters of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeployPolicyRequest request =
       UpdateDeployPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudDeployClient.updateDeployPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateDeployPolicyRequest,Operation>`

updateDeployPolicyOperationCallable()

public final OperationCallable<UpdateDeployPolicyRequest,DeployPolicy,OperationMetadata> updateDeployPolicyOperationCallable()

Updates the parameters of a single DeployPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateDeployPolicyRequest request =
       UpdateDeployPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDeployPolicy(DeployPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<DeployPolicy, OperationMetadata> future =
       cloudDeployClient.updateDeployPolicyOperationCallable().futureCall(request);
   // Do something.
   DeployPolicy response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateDeployPolicyRequest,DeployPolicy,OperationMetadata>`

updateTargetAsync(Target target, FieldMask updateMask)

public final OperationFuture<Target,OperationMetadata> updateTargetAsync(Target target, FieldMask updateMask)

Updates the parameters of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   Target target = Target.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Target response = cloudDeployClient.updateTargetAsync(target, updateMask).get();
 }

Parameters
Name	Description
`target`	`Target` Required. The `Target` to update.
`updateMask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the `Target` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

Returns
Type	Description
`OperationFuture<Target,OperationMetadata>`

updateTargetAsync(UpdateTargetRequest request)

public final OperationFuture<Target,OperationMetadata> updateTargetAsync(UpdateTargetRequest request)

Updates the parameters of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateTargetRequest request =
       UpdateTargetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   Target response = cloudDeployClient.updateTargetAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateTargetRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Target,OperationMetadata>`

updateTargetCallable()

public final UnaryCallable<UpdateTargetRequest,Operation> updateTargetCallable()

Updates the parameters of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateTargetRequest request =
       UpdateTargetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = cloudDeployClient.updateTargetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateTargetRequest,Operation>`

updateTargetOperationCallable()

public final OperationCallable<UpdateTargetRequest,Target,OperationMetadata> updateTargetOperationCallable()

Updates the parameters of a single Target.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
   UpdateTargetRequest request =
       UpdateTargetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTarget(Target.newBuilder().build())
           .setRequestId("requestId693933066")
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<Target, OperationMetadata> future =
       cloudDeployClient.updateTargetOperationCallable().futureCall(request);
   // Do something.
   Target response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateTargetRequest,Target,OperationMetadata>`