| 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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteDeliveryPipeline | Deletes a single DeliveryPipeline. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RollbackTarget | Creates a |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTarget | Deletes a single Target. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCustomTargetType | Updates a single CustomTargetType. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteCustomTargetType | Deletes a single CustomTargetType. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ApproveRollout | Approves a Rollout. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAutomation | Deletes a single Automation resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CancelAutomationRun | Cancels an AutomationRun. The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation | Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy | Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
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(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 | AbandonReleaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AbandonReleaseResponse | |
abandonRelease(ReleaseName name)
public final AbandonReleaseResponse abandonRelease(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 | ReleaseNameRequired. Name of the Release. Format is
|
| 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 | StringRequired. Name of the Release. Format is
|
| 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(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")
.build();
AdvanceRolloutResponse response = cloudDeployClient.advanceRollout(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | AdvanceRolloutRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AdvanceRolloutResponse | |
advanceRollout(RolloutName name, String phaseId)
public final AdvanceRolloutResponse advanceRollout(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 | RolloutNameRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID to advance the |
| 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 | StringRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID to advance the |
| 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")
.build();
ApiFuture<AdvanceRolloutResponse> future =
cloudDeployClient.advanceRolloutCallable().futureCall(request);
// Do something.
AdvanceRolloutResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<AdvanceRolloutRequest,AdvanceRolloutResponse> | |
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)
.build();
ApproveRolloutResponse response = cloudDeployClient.approveRollout(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | ApproveRolloutRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ApproveRolloutResponse | |
approveRollout(RolloutName name)
public final ApproveRolloutResponse approveRollout(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 | RolloutNameRequired. Name of the Rollout. Format is
|
| 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 | StringRequired. Name of the Rollout. Format is
|
| 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)
.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(AutomationRunName name)
public final CancelAutomationRunResponse cancelAutomationRun(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 | AutomationRunNameRequired. Name of the |
| Returns | |
|---|---|
| Type | Description |
CancelAutomationRunResponse | |
cancelAutomationRun(CancelAutomationRunRequest request)
public final CancelAutomationRunResponse cancelAutomationRun(CancelAutomationRunRequest request)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()) {
CancelAutomationRunRequest request =
CancelAutomationRunRequest.newBuilder()
.setName(
AutomationRunName.of(
"[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
.toString())
.build();
CancelAutomationRunResponse response = cloudDeployClient.cancelAutomationRun(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | CancelAutomationRunRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CancelAutomationRunResponse | |
cancelAutomationRun(String name)
public final CancelAutomationRunResponse cancelAutomationRun(String 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()) {
String name =
AutomationRunName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[AUTOMATION_RUN]")
.toString();
CancelAutomationRunResponse response = cloudDeployClient.cancelAutomationRun(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. Name of the |
| Returns | |
|---|---|
| Type | Description |
CancelAutomationRunResponse | |
cancelAutomationRunCallable()
public final UnaryCallable<CancelAutomationRunRequest,CancelAutomationRunResponse> cancelAutomationRunCallable()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()) {
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(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())
.build();
CancelRolloutResponse response = cloudDeployClient.cancelRollout(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | CancelRolloutRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CancelRolloutResponse | |
cancelRollout(RolloutName name)
public final CancelRolloutResponse cancelRollout(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 | RolloutNameRequired. Name of the Rollout. Format is
|
| 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 | StringRequired. Name of the Rollout. Format is
|
| 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())
.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(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 | CreateAutomationRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Automation,OperationMetadata> | |
createAutomationAsync(DeliveryPipelineName parent, Automation automation, String automationId)
public final OperationFuture<Automation,OperationMetadata> createAutomationAsync(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 | DeliveryPipelineNameRequired. The parent collection in which the |
automation | AutomationRequired. The |
automationId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
automation | AutomationRequired. The |
automationId | StringRequired. ID of the |
| 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(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 | CreateCustomTargetTypeRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<CustomTargetType,OperationMetadata> | |
createCustomTargetTypeAsync(LocationName parent, CustomTargetType customTargetType, String customTargetTypeId)
public final OperationFuture<CustomTargetType,OperationMetadata> createCustomTargetTypeAsync(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 | LocationNameRequired. The parent collection in which the |
customTargetType | CustomTargetTypeRequired. The |
customTargetTypeId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
customTargetType | CustomTargetTypeRequired. The |
customTargetTypeId | StringRequired. ID of the |
| 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(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 | CreateDeliveryPipelineRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<DeliveryPipeline,OperationMetadata> | |
createDeliveryPipelineAsync(LocationName parent, DeliveryPipeline deliveryPipeline, String deliveryPipelineId)
public final OperationFuture<DeliveryPipeline,OperationMetadata> createDeliveryPipelineAsync(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 | LocationNameRequired. The parent collection in which the |
deliveryPipeline | DeliveryPipelineRequired. The |
deliveryPipelineId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
deliveryPipeline | DeliveryPipelineRequired. The |
deliveryPipelineId | StringRequired. ID of the |
| 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> | |
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)
.build();
Release response = cloudDeployClient.createReleaseAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | CreateReleaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Release,OperationMetadata> | |
createReleaseAsync(DeliveryPipelineName parent, Release release, String releaseId)
public final OperationFuture<Release,OperationMetadata> createReleaseAsync(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 | DeliveryPipelineNameRequired. The parent collection in which the |
release | ReleaseRequired. The |
releaseId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
release | ReleaseRequired. The |
releaseId | StringRequired. ID of the |
| 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)
.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)
.build();
OperationFuture<Release, OperationMetadata> future =
cloudDeployClient.createReleaseOperationCallable().futureCall(request);
// Do something.
Release response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateReleaseRequest,Release,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)
.setStartingPhaseId("startingPhaseId-326529130")
.build();
Rollout response = cloudDeployClient.createRolloutAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | CreateRolloutRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Rollout,OperationMetadata> | |
createRolloutAsync(ReleaseName parent, Rollout rollout, String rolloutId)
public final OperationFuture<Rollout,OperationMetadata> createRolloutAsync(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 | ReleaseNameRequired. The parent collection in which the |
rollout | RolloutRequired. The |
rolloutId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
rollout | RolloutRequired. The |
rolloutId | StringRequired. ID of the |
| 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)
.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)
.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(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 | CreateTargetRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Target,OperationMetadata> | |
createTargetAsync(LocationName parent, Target target, String targetId)
public final OperationFuture<Target,OperationMetadata> createTargetAsync(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 | LocationNameRequired. The parent collection in which the |
target | TargetRequired. The |
targetId | StringRequired. ID of the |
| 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 | StringRequired. The parent collection in which the |
target | TargetRequired. The |
targetId | StringRequired. ID of the |
| 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(AutomationName name)
public final OperationFuture<Empty,OperationMetadata> deleteAutomationAsync(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 | AutomationNameRequired. The name of the |
| 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 | DeleteAutomationRequestThe 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 | StringRequired. The name of the |
| 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(CustomTargetTypeName name)
public final OperationFuture<Empty,OperationMetadata> deleteCustomTargetTypeAsync(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 | CustomTargetTypeNameRequired. The name of the |
| 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 | DeleteCustomTargetTypeRequestThe 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 | StringRequired. The name of the |
| 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(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 | DeleteDeliveryPipelineRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteDeliveryPipelineAsync(DeliveryPipelineName name)
public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(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 | DeliveryPipelineNameRequired. The name of the |
| 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 | StringRequired. The name of the |
| 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> | |
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 | DeleteTargetRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteTargetAsync(TargetName name)
public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(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 | TargetNameRequired. The name of the |
| 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 | StringRequired. The name of the |
| 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(AutomationName name)
public final Automation getAutomation(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 | AutomationNameRequired. Name of the |
| 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 | GetAutomationRequestThe 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 | StringRequired. Name of the |
| 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(AutomationRunName name)
public final AutomationRun getAutomationRun(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 | AutomationRunNameRequired. Name of the |
| 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 | GetAutomationRunRequestThe 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 | StringRequired. Name of the |
| 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(ConfigName name)
public final Config getConfig(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 | ConfigNameRequired. 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 | GetConfigRequestThe 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 | StringRequired. 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(CustomTargetTypeName name)
public final CustomTargetType getCustomTargetType(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 | CustomTargetTypeNameRequired. Name of the |
| 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 | GetCustomTargetTypeRequestThe 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 | StringRequired. Name of the |
| 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(DeliveryPipelineName name)
public final DeliveryPipeline getDeliveryPipeline(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 | DeliveryPipelineNameRequired. Name of the |
| 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 | GetDeliveryPipelineRequestThe 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 | StringRequired. Name of the |
| 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> | |
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(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = cloudDeployClient.getIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | com.google.iam.v1.GetIamPolicyRequestThe 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(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.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(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 | GetJobRunRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
JobRun | |
getJobRun(JobRunName name)
public final JobRun getJobRun(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 | JobRunNameRequired. Name of the |
| 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 | StringRequired. Name of the |
| 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.GetLocationRequestThe 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(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 | GetReleaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Release | |
getRelease(ReleaseName name)
public final Release getRelease(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 | ReleaseNameRequired. Name of the |
| 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 | StringRequired. Name of the |
| 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(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 | GetRolloutRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Rollout | |
getRollout(RolloutName name)
public final Rollout getRollout(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 | RolloutNameRequired. Name of the |
| 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 | StringRequired. Name of the |
| 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 CloudDeploySettings getSettings()| Returns | |
|---|---|
| Type | Description |
CloudDeploySettings | |
getStub()
public CloudDeployStub getStub()| Returns | |
|---|---|
| Type | Description |
CloudDeployStub | |
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 | GetTargetRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Target | |
getTarget(TargetName name)
public final Target getTarget(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 | TargetNameRequired. Name of the |
| 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 | StringRequired. Name of the |
| 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(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")
.build();
IgnoreJobResponse response = cloudDeployClient.ignoreJob(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | IgnoreJobRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
IgnoreJobResponse | |
ignoreJob(RolloutName rollout, String phaseId, String jobId)
public final IgnoreJobResponse ignoreJob(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 | RolloutNameRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID the Job to ignore belongs to. |
jobId | StringRequired. The job ID for the Job to ignore. |
| 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 | StringRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID the Job to ignore belongs to. |
jobId | StringRequired. 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")
.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(DeliveryPipelineName parent)
public final CloudDeployClient.ListAutomationRunsPagedResponse listAutomationRuns(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 | DeliveryPipelineNameRequired. The parent |
| 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 | ListAutomationRunsRequestThe 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 | StringRequired. The parent |
| 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(DeliveryPipelineName parent)
public final CloudDeployClient.ListAutomationsPagedResponse listAutomations(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 | DeliveryPipelineNameRequired. The parent |
| 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 | ListAutomationsRequestThe 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 | StringRequired. The parent |
| 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(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 | ListCustomTargetTypesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudDeployClient.ListCustomTargetTypesPagedResponse | |
listCustomTargetTypes(LocationName parent)
public final CloudDeployClient.ListCustomTargetTypesPagedResponse listCustomTargetTypes(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 | LocationNameRequired. The parent that owns this collection of custom target types. Format
must be |
| 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 | StringRequired. The parent that owns this collection of custom target types. Format
must be |
| 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(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 | ListDeliveryPipelinesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudDeployClient.ListDeliveryPipelinesPagedResponse | |
listDeliveryPipelines(LocationName parent)
public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(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 | LocationNameRequired. The parent, which owns this collection of pipelines. Format must be
|
| 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 | StringRequired. The parent, which owns this collection of pipelines. Format must be
|
| 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> | |
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 | ListJobRunsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudDeployClient.ListJobRunsPagedResponse | |
listJobRuns(RolloutName parent)
public final CloudDeployClient.ListJobRunsPagedResponse listJobRuns(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 | RolloutNameRequired. The |
| 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 | StringRequired. The |
| 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.ListLocationsRequestThe 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(DeliveryPipelineName parent)
public final CloudDeployClient.ListReleasesPagedResponse listReleases(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 | DeliveryPipelineNameRequired. The |
| 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 | ListReleasesRequestThe 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 | StringRequired. The |
| 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(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 | ListRolloutsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudDeployClient.ListRolloutsPagedResponse | |
listRollouts(ReleaseName parent)
public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(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 | ReleaseNameRequired. The |
| 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 | StringRequired. The |
| 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(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 | ListTargetsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudDeployClient.ListTargetsPagedResponse | |
listTargets(LocationName parent)
public final CloudDeployClient.ListTargetsPagedResponse listTargets(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 | LocationNameRequired. The parent, which owns this collection of targets. Format must be
|
| 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 | StringRequired. The parent, which owns this collection of targets. Format must be
|
| 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(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")
.build();
RetryJobResponse response = cloudDeployClient.retryJob(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | RetryJobRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RetryJobResponse | |
retryJob(RolloutName rollout, String phaseId, String jobId)
public final RetryJobResponse retryJob(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 | RolloutNameRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID the Job to retry belongs to. |
jobId | StringRequired. The job ID for the Job to retry. |
| 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 | StringRequired. Name of the Rollout. Format is
|
phaseId | StringRequired. The phase ID the Job to retry belongs to. |
jobId | StringRequired. 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")
.build();
ApiFuture<RetryJobResponse> future = cloudDeployClient.retryJobCallable().futureCall(request);
// Do something.
RetryJobResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<RetryJobRequest,RetryJobResponse> | |
rollbackTarget(DeliveryPipelineName name, String targetId, String rolloutId)
public final RollbackTargetResponse rollbackTarget(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 | DeliveryPipelineNameRequired. The |
targetId | StringRequired. ID of the |
rolloutId | StringRequired. ID of the rollback |
| 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)
.build();
RollbackTargetResponse response = cloudDeployClient.rollbackTarget(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | RollbackTargetRequestThe 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 | StringRequired. The |
targetId | StringRequired. ID of the |
rolloutId | StringRequired. ID of the rollback |
| 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)
.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(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = cloudDeployClient.setIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | com.google.iam.v1.SetIamPolicyRequestThe 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(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.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(JobRunName name)
public final TerminateJobRunResponse terminateJobRun(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 | JobRunNameRequired. Name of the |
| 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())
.build();
TerminateJobRunResponse response = cloudDeployClient.terminateJobRun(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | TerminateJobRunRequestThe 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 | StringRequired. Name of the |
| 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())
.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.TestIamPermissionsRequestThe 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 | AutomationRequired. The |
updateMask | FieldMaskRequired. Field mask is used to specify the fields to be overwritten in the
|
| 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 | UpdateAutomationRequestThe 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 | CustomTargetTypeRequired. The |
updateMask | FieldMaskRequired. Field mask is used to specify the fields to be overwritten in the
|
| 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 | UpdateCustomTargetTypeRequestThe 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 | DeliveryPipelineRequired. The |
updateMask | FieldMaskRequired. Field mask is used to specify the fields to be overwritten in the
|
| 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 | UpdateDeliveryPipelineRequestThe 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> | |
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 | TargetRequired. The |
updateMask | FieldMaskRequired. Field mask is used to specify the fields to be overwritten in the Target resource by the update. 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 | UpdateTargetRequestThe 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> | |