- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.8
- 1.0.2
public class CloudDeployClient implements BackgroundResource
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:
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns 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:
CloudDeploySettings cloudDeploySettings =
CloudDeploySettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudDeployClient cloudDeployClient = CloudDeployClient.create(cloudDeploySettings);
To customize the endpoint:
CloudDeploySettings cloudDeploySettings =
CloudDeploySettings.newBuilder().setEndpoint(myEndpoint).build();
CloudDeployClient cloudDeployClient = CloudDeployClient.create(cloudDeploySettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final CloudDeployClient create()
Constructs an instance of CloudDeployClient with default settings.
Type | Description |
CloudDeployClient |
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.
Name | Description |
settings | CloudDeploySettings |
Type | Description |
CloudDeployClient |
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).
Name | Description |
stub | CloudDeployStub |
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.
Name | Description |
settings | CloudDeploySettings |
CloudDeployClient(CloudDeployStub stub)
protected CloudDeployClient(CloudDeployStub stub)
Name | Description |
stub | CloudDeployStub |
Methods
approveRollout(ApproveRolloutRequest request)
public final ApproveRolloutResponse approveRollout(ApproveRolloutRequest request)
Approves a Rollout.
Sample code:
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);
}
Name | Description |
request | ApproveRolloutRequest The request object containing all of the parameters for the API call. |
Type | Description |
ApproveRolloutResponse |
approveRollout(RolloutName name)
public final ApproveRolloutResponse approveRollout(RolloutName name)
Approves a Rollout.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
RolloutName name =
RolloutName.of(
"[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
ApproveRolloutResponse response = cloudDeployClient.approveRollout(name);
}
Name | Description |
name | RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
Type | Description |
ApproveRolloutResponse |
approveRollout(String name)
public final ApproveRolloutResponse approveRollout(String name)
Approves a Rollout.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name =
RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
.toString();
ApproveRolloutResponse response = cloudDeployClient.approveRollout(name);
}
Name | Description |
name | String Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
Type | Description |
ApproveRolloutResponse |
approveRolloutCallable()
public final UnaryCallable<ApproveRolloutRequest,ApproveRolloutResponse> approveRolloutCallable()
Approves a Rollout.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ApproveRolloutRequest request =
ApproveRolloutRequest.newBuilder()
.setName(
RolloutName.of(
"[PROJECT]",
"[LOCATION]",
"[DELIVERY_PIPELINE]",
"[RELEASE]",
"[ROLLOUT]")
.toString())
.setApproved(true)
.build();
ApiFuture
Type | Description |
UnaryCallable<ApproveRolloutRequest,ApproveRolloutResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createDeliveryPipelineAsync(CreateDeliveryPipelineRequest request)
public final OperationFuture<DeliveryPipeline,OperationMetadata> createDeliveryPipelineAsync(CreateDeliveryPipelineRequest request)
Creates a new DeliveryPipeline in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateDeliveryPipelineRequest request =
CreateDeliveryPipelineRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setDeliveryPipelineId("deliveryPipelineId-632411535")
.setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
DeliveryPipeline response = cloudDeployClient.createDeliveryPipelineAsync(request).get();
}
Name | Description |
request | CreateDeliveryPipelineRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Name | Description |
parent | LocationName Required. The parent collection in which the |
deliveryPipeline | DeliveryPipeline Required. The |
deliveryPipelineId | String Required. ID of the |
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
DeliveryPipeline deliveryPipeline = DeliveryPipeline.newBuilder().build();
String deliveryPipelineId = "deliveryPipelineId-632411535";
DeliveryPipeline response =
cloudDeployClient
.createDeliveryPipelineAsync(parent, deliveryPipeline, deliveryPipelineId)
.get();
}
Name | Description |
parent | String Required. The parent collection in which the |
deliveryPipeline | DeliveryPipeline Required. The |
deliveryPipelineId | String Required. ID of the |
Type | Description |
OperationFuture<DeliveryPipeline,OperationMetadata> |
createDeliveryPipelineCallable()
public final UnaryCallable<CreateDeliveryPipelineRequest,Operation> createDeliveryPipelineCallable()
Creates a new DeliveryPipeline in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateDeliveryPipelineRequest request =
CreateDeliveryPipelineRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.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();
}
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateDeliveryPipelineRequest request =
CreateDeliveryPipelineRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setDeliveryPipelineId("deliveryPipelineId-632411535")
.setDeliveryPipeline(DeliveryPipeline.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture
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:
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();
}
Name | Description |
request | CreateReleaseRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Name | Description |
parent | DeliveryPipelineName Required. The parent collection in which the |
release | Release Required. The |
releaseId | String Required. ID of the |
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:
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();
}
Name | Description |
parent | String Required. The parent collection in which the |
release | Release Required. The |
releaseId | String Required. ID of the |
Type | Description |
OperationFuture<Release,OperationMetadata> |
createReleaseCallable()
public final UnaryCallable<CreateReleaseRequest,Operation> createReleaseCallable()
Creates a new Release in a given project and location.
Sample code:
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();
}
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:
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
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:
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)
.build();
Rollout response = cloudDeployClient.createRolloutAsync(request).get();
}
Name | Description |
request | CreateRolloutRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Name | Description |
parent | ReleaseName Required. The parent collection in which the |
rollout | Rollout Required. The |
rolloutId | String Required. ID of the |
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:
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();
}
Name | Description |
parent | String Required. The parent collection in which the |
rollout | Rollout Required. The |
rolloutId | String Required. ID of the |
Type | Description |
OperationFuture<Rollout,OperationMetadata> |
createRolloutCallable()
public final UnaryCallable<CreateRolloutRequest,Operation> createRolloutCallable()
Creates a new Rollout in a given project and location.
Sample code:
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)
.build();
ApiFuture<Operation> future = cloudDeployClient.createRolloutCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
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:
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)
.build();
OperationFuture
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateTargetRequest request =
CreateTargetRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
.setTargetId("targetId-441951604")
.setTarget(Target.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Target response = cloudDeployClient.createTargetAsync(request).get();
}
Name | Description |
request | CreateTargetRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Name | Description |
parent | LocationName Required. The parent collection in which the |
target | Target Required. The |
targetId | String Required. ID of the |
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
Target target = Target.newBuilder().build();
String targetId = "targetId-441951604";
Target response = cloudDeployClient.createTargetAsync(parent, target, targetId).get();
}
Name | Description |
parent | String Required. The parent collection in which the |
target | Target Required. The |
targetId | String Required. ID of the |
Type | Description |
OperationFuture<Target,OperationMetadata> |
createTargetCallable()
public final UnaryCallable<CreateTargetRequest,Operation> createTargetCallable()
Creates a new Target in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateTargetRequest request =
CreateTargetRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").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();
}
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
CreateTargetRequest request =
CreateTargetRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
.setTargetId("targetId-441951604")
.setTarget(Target.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture
Type | Description |
OperationCallable<CreateTargetRequest,Target,OperationMetadata> |
deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request)
Deletes a single DeliveryPipeline.
Sample code:
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();
}
Name | Description |
request | DeleteDeliveryPipelineRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteDeliveryPipelineAsync(DeliveryPipelineName name)
public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(DeliveryPipelineName name)
Deletes a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
DeliveryPipelineName name =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
cloudDeployClient.deleteDeliveryPipelineAsync(name).get();
}
Name | Description |
name | DeliveryPipelineName Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteDeliveryPipelineAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteDeliveryPipelineAsync(String name)
Deletes a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
cloudDeployClient.deleteDeliveryPipelineAsync(name).get();
}
Name | Description |
name | String Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteDeliveryPipelineCallable()
public final UnaryCallable<DeleteDeliveryPipelineRequest,Operation> deleteDeliveryPipelineCallable()
Deletes a single DeliveryPipeline.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteDeliveryPipelineRequest,Operation> |
deleteDeliveryPipelineOperationCallable()
public final OperationCallable<DeleteDeliveryPipelineRequest,Empty,OperationMetadata> deleteDeliveryPipelineOperationCallable()
Deletes a single DeliveryPipeline.
Sample code:
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
Type | Description |
OperationCallable<DeleteDeliveryPipelineRequest,Empty,OperationMetadata> |
deleteTargetAsync(DeleteTargetRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(DeleteTargetRequest request)
Deletes a single Target.
Sample code:
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();
}
Name | Description |
request | DeleteTargetRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteTargetAsync(TargetName name)
public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(TargetName name)
Deletes a single Target.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
TargetName name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]");
cloudDeployClient.deleteTargetAsync(name).get();
}
Name | Description |
name | TargetName Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteTargetAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteTargetAsync(String name)
Deletes a single Target.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
cloudDeployClient.deleteTargetAsync(name).get();
}
Name | Description |
name | String Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteTargetCallable()
public final UnaryCallable<DeleteTargetRequest,Operation> deleteTargetCallable()
Deletes a single Target.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteTargetRequest,Operation> |
deleteTargetOperationCallable()
public final OperationCallable<DeleteTargetRequest,Empty,OperationMetadata> deleteTargetOperationCallable()
Deletes a single Target.
Sample code:
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
Type | Description |
OperationCallable<DeleteTargetRequest,Empty,OperationMetadata> |
getConfig(ConfigName name)
public final Config getConfig(ConfigName name)
Gets the configuration for a location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ConfigName name = ConfigName.of("[PROJECT]", "[LOCATION]");
Config response = cloudDeployClient.getConfig(name);
}
Name | Description |
name | ConfigName Required. Name of requested configuration. |
Type | Description |
Config |
getConfig(GetConfigRequest request)
public final Config getConfig(GetConfigRequest request)
Gets the configuration for a location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
GetConfigRequest request =
GetConfigRequest.newBuilder()
.setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString())
.build();
Config response = cloudDeployClient.getConfig(request);
}
Name | Description |
request | GetConfigRequest The request object containing all of the parameters for the API call. |
Type | Description |
Config |
getConfig(String name)
public final Config getConfig(String name)
Gets the configuration for a location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name = ConfigName.of("[PROJECT]", "[LOCATION]").toString();
Config response = cloudDeployClient.getConfig(name);
}
Name | Description |
name | String Required. Name of requested configuration. |
Type | Description |
Config |
getConfigCallable()
public final UnaryCallable<GetConfigRequest,Config> getConfigCallable()
Gets the configuration for a location.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetConfigRequest,Config> |
getDeliveryPipeline(DeliveryPipelineName name)
public final DeliveryPipeline getDeliveryPipeline(DeliveryPipelineName name)
Gets details of a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
DeliveryPipelineName name =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(name);
}
Name | Description |
name | DeliveryPipelineName Required. Name of the |
Type | Description |
DeliveryPipeline |
getDeliveryPipeline(GetDeliveryPipelineRequest request)
public final DeliveryPipeline getDeliveryPipeline(GetDeliveryPipelineRequest request)
Gets details of a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
GetDeliveryPipelineRequest request =
GetDeliveryPipelineRequest.newBuilder()
.setName(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.build();
DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(request);
}
Name | Description |
request | GetDeliveryPipelineRequest The request object containing all of the parameters for the API call. |
Type | Description |
DeliveryPipeline |
getDeliveryPipeline(String name)
public final DeliveryPipeline getDeliveryPipeline(String name)
Gets details of a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
DeliveryPipeline response = cloudDeployClient.getDeliveryPipeline(name);
}
Name | Description |
name | String Required. Name of the |
Type | Description |
DeliveryPipeline |
getDeliveryPipelineCallable()
public final UnaryCallable<GetDeliveryPipelineRequest,DeliveryPipeline> getDeliveryPipelineCallable()
Gets details of a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
GetDeliveryPipelineRequest request =
GetDeliveryPipelineRequest.newBuilder()
.setName(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.build();
ApiFuture
Type | Description |
UnaryCallable<GetDeliveryPipelineRequest,DeliveryPipeline> |
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.
Type | Description |
OperationsClient |
getRelease(GetReleaseRequest request)
public final Release getRelease(GetReleaseRequest request)
Gets details of a single Release.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
GetReleaseRequest request =
GetReleaseRequest.newBuilder()
.setName(
ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]")
.toString())
.build();
Release response = cloudDeployClient.getRelease(request);
}
Name | Description |
request | GetReleaseRequest The request object containing all of the parameters for the API call. |
Type | Description |
Release |
getRelease(ReleaseName name)
public final Release getRelease(ReleaseName name)
Gets details of a single Release.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ReleaseName name =
ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
Release response = cloudDeployClient.getRelease(name);
}
Name | Description |
name | ReleaseName Required. Name of the |
Type | Description |
Release |
getRelease(String name)
public final Release getRelease(String name)
Gets details of a single Release.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name =
ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
Release response = cloudDeployClient.getRelease(name);
}
Name | Description |
name | String Required. Name of the |
Type | Description |
Release |
getReleaseCallable()
public final UnaryCallable<GetReleaseRequest,Release> getReleaseCallable()
Gets details of a single Release.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetReleaseRequest,Release> |
getRollout(GetRolloutRequest request)
public final Rollout getRollout(GetRolloutRequest request)
Gets details of a single Rollout.
Sample code:
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);
}
Name | Description |
request | GetRolloutRequest The request object containing all of the parameters for the API call. |
Type | Description |
Rollout |
getRollout(RolloutName name)
public final Rollout getRollout(RolloutName name)
Gets details of a single Rollout.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
RolloutName name =
RolloutName.of(
"[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
Rollout response = cloudDeployClient.getRollout(name);
}
Name | Description |
name | RolloutName Required. Name of the |
Type | Description |
Rollout |
getRollout(String name)
public final Rollout getRollout(String name)
Gets details of a single Rollout.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name =
RolloutName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]")
.toString();
Rollout response = cloudDeployClient.getRollout(name);
}
Name | Description |
name | String Required. Name of the |
Type | Description |
Rollout |
getRolloutCallable()
public final UnaryCallable<GetRolloutRequest,Rollout> getRolloutCallable()
Gets details of a single Rollout.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetRolloutRequest,Rollout> |
getSettings()
public final CloudDeploySettings getSettings()
Type | Description |
CloudDeploySettings |
getStub()
public CloudDeployStub getStub()
Type | Description |
CloudDeployStub |
getTarget(GetTargetRequest request)
public final Target getTarget(GetTargetRequest request)
Gets details of a single Target.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
GetTargetRequest request =
GetTargetRequest.newBuilder()
.setName(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
.build();
Target response = cloudDeployClient.getTarget(request);
}
Name | Description |
request | GetTargetRequest The request object containing all of the parameters for the API call. |
Type | Description |
Target |
getTarget(TargetName name)
public final Target getTarget(TargetName name)
Gets details of a single Target.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
TargetName name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]");
Target response = cloudDeployClient.getTarget(name);
}
Name | Description |
name | TargetName Required. Name of the |
Type | Description |
Target |
getTarget(String name)
public final Target getTarget(String name)
Gets details of a single Target.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String name = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
Target response = cloudDeployClient.getTarget(name);
}
Name | Description |
name | String Required. Name of the |
Type | Description |
Target |
getTargetCallable()
public final UnaryCallable<GetTargetRequest,Target> getTargetCallable()
Gets details of a single Target.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetTargetRequest,Target> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listDeliveryPipelines(ListDeliveryPipelinesRequest request)
public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(ListDeliveryPipelinesRequest request)
Lists DeliveryPipelines in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListDeliveryPipelinesRequest request =
ListDeliveryPipelinesRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (DeliveryPipeline element :
cloudDeployClient.listDeliveryPipelines(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListDeliveryPipelinesRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudDeployClient.ListDeliveryPipelinesPagedResponse |
listDeliveryPipelines(LocationName parent)
public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(LocationName parent)
Lists DeliveryPipelines in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (DeliveryPipeline element :
cloudDeployClient.listDeliveryPipelines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. |
Type | Description |
CloudDeployClient.ListDeliveryPipelinesPagedResponse |
listDeliveryPipelines(String parent)
public final CloudDeployClient.ListDeliveryPipelinesPagedResponse listDeliveryPipelines(String parent)
Lists DeliveryPipelines in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
for (DeliveryPipeline element :
cloudDeployClient.listDeliveryPipelines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. |
Type | Description |
CloudDeployClient.ListDeliveryPipelinesPagedResponse |
listDeliveryPipelinesCallable()
public final UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse> listDeliveryPipelinesCallable()
Lists DeliveryPipelines in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListDeliveryPipelinesRequest request =
ListDeliveryPipelinesRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListDeliveryPipelinesResponse response =
cloudDeployClient.listDeliveryPipelinesCallable().call(request);
for (DeliveryPipeline element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse> |
listDeliveryPipelinesPagedCallable()
public final UnaryCallable<ListDeliveryPipelinesRequest,CloudDeployClient.ListDeliveryPipelinesPagedResponse> listDeliveryPipelinesPagedCallable()
Lists DeliveryPipelines in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListDeliveryPipelinesRequest request =
ListDeliveryPipelinesRequest.newBuilder()
.setParent(
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture
Type | Description |
UnaryCallable<ListDeliveryPipelinesRequest,ListDeliveryPipelinesPagedResponse> |
listReleases(DeliveryPipelineName parent)
public final CloudDeployClient.ListReleasesPagedResponse listReleases(DeliveryPipelineName parent)
Lists Releases in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
DeliveryPipelineName parent =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]");
for (Release element : cloudDeployClient.listReleases(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | DeliveryPipelineName Required. The |
Type | Description |
CloudDeployClient.ListReleasesPagedResponse |
listReleases(ListReleasesRequest request)
public final CloudDeployClient.ListReleasesPagedResponse listReleases(ListReleasesRequest request)
Lists Releases in a given project and location.
Sample code:
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);
}
}
Name | Description |
request | ListReleasesRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudDeployClient.ListReleasesPagedResponse |
listReleases(String parent)
public final CloudDeployClient.ListReleasesPagedResponse listReleases(String parent)
Lists Releases in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent =
DeliveryPipelineName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]").toString();
for (Release element : cloudDeployClient.listReleases(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The |
Type | Description |
CloudDeployClient.ListReleasesPagedResponse |
listReleasesCallable()
public final UnaryCallable<ListReleasesRequest,ListReleasesResponse> listReleasesCallable()
Lists Releases in a given project and location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListReleasesRequest,ListReleasesResponse> |
listReleasesPagedCallable()
public final UnaryCallable<ListReleasesRequest,CloudDeployClient.ListReleasesPagedResponse> listReleasesPagedCallable()
Lists Releases in a given project and location.
Sample code:
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);
}
}
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:
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);
}
}
Name | Description |
request | ListRolloutsRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudDeployClient.ListRolloutsPagedResponse |
listRollouts(ReleaseName parent)
public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(ReleaseName parent)
Lists Rollouts in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ReleaseName parent =
ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
for (Rollout element : cloudDeployClient.listRollouts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | ReleaseName Required. The |
Type | Description |
CloudDeployClient.ListRolloutsPagedResponse |
listRollouts(String parent)
public final CloudDeployClient.ListRolloutsPagedResponse listRollouts(String parent)
Lists Rollouts in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent =
ReleaseName.of("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]").toString();
for (Rollout element : cloudDeployClient.listRollouts(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The |
Type | Description |
CloudDeployClient.ListRolloutsPagedResponse |
listRolloutsCallable()
public final UnaryCallable<ListRolloutsRequest,ListRolloutsResponse> listRolloutsCallable()
Lists Rollouts in a given project and location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListRolloutsRequest,ListRolloutsResponse> |
listRolloutsPagedCallable()
public final UnaryCallable<ListRolloutsRequest,CloudDeployClient.ListRolloutsPagedResponse> listRolloutsPagedCallable()
Lists Rollouts in a given project and location.
Sample code:
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);
}
}
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListTargetsRequest request =
ListTargetsRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Target element : cloudDeployClient.listTargets(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListTargetsRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudDeployClient.ListTargetsPagedResponse |
listTargets(LocationName parent)
public final CloudDeployClient.ListTargetsPagedResponse listTargets(LocationName parent)
Lists Targets in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Target element : cloudDeployClient.listTargets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}. |
Type | Description |
CloudDeployClient.ListTargetsPagedResponse |
listTargets(String parent)
public final CloudDeployClient.ListTargetsPagedResponse listTargets(String parent)
Lists Targets in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
String parent = TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString();
for (Target element : cloudDeployClient.listTargets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}. |
Type | Description |
CloudDeployClient.ListTargetsPagedResponse |
listTargetsCallable()
public final UnaryCallable<ListTargetsRequest,ListTargetsResponse> listTargetsCallable()
Lists Targets in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListTargetsRequest request =
ListTargetsRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListTargetsResponse response = cloudDeployClient.listTargetsCallable().call(request);
for (Target element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListTargetsRequest,ListTargetsResponse> |
listTargetsPagedCallable()
public final UnaryCallable<ListTargetsRequest,CloudDeployClient.ListTargetsPagedResponse> listTargetsPagedCallable()
Lists Targets in a given project and location.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
ListTargetsRequest request =
ListTargetsRequest.newBuilder()
.setParent(TargetName.of("[PROJECT]", "[LOCATION]", "[TARGET]").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);
}
}
Type | Description |
UnaryCallable<ListTargetsRequest,ListTargetsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateDeliveryPipelineAsync(DeliveryPipeline deliveryPipeline, FieldMask updateMask)
public final OperationFuture<DeliveryPipeline,OperationMetadata> updateDeliveryPipelineAsync(DeliveryPipeline deliveryPipeline, FieldMask updateMask)
Updates the parameters of a single DeliveryPipeline.
Sample code:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
DeliveryPipeline deliveryPipeline = DeliveryPipeline.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
DeliveryPipeline response =
cloudDeployClient.updateDeliveryPipelineAsync(deliveryPipeline, updateMask).get();
}
Name | Description |
deliveryPipeline | DeliveryPipeline Required. The |
updateMask | FieldMask Required. Field mask is used to specify the fields to be overwritten in the
|
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:
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();
}
Name | Description |
request | UpdateDeliveryPipelineRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<DeliveryPipeline,OperationMetadata> |
updateDeliveryPipelineCallable()
public final UnaryCallable<UpdateDeliveryPipelineRequest,Operation> updateDeliveryPipelineCallable()
Updates the parameters of a single DeliveryPipeline.
Sample code:
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();
}
Type | Description |
UnaryCallable<UpdateDeliveryPipelineRequest,Operation> |
updateDeliveryPipelineOperationCallable()
public final OperationCallable<UpdateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata> updateDeliveryPipelineOperationCallable()
Updates the parameters of a single DeliveryPipeline.
Sample code:
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
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:
try (CloudDeployClient cloudDeployClient = CloudDeployClient.create()) {
Target target = Target.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Target response = cloudDeployClient.updateTargetAsync(target, updateMask).get();
}
Name | Description |
target | Target Required. The |
updateMask | FieldMask Required. 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 is in the mask. If the user does not provide a mask then all fields will be overwritten. |
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:
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();
}
Name | Description |
request | UpdateTargetRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Target,OperationMetadata> |
updateTargetCallable()
public final UnaryCallable<UpdateTargetRequest,Operation> updateTargetCallable()
Updates the parameters of a single Target.
Sample code:
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();
}
Type | Description |
UnaryCallable<UpdateTargetRequest,Operation> |
updateTargetOperationCallable()
public final OperationCallable<UpdateTargetRequest,Target,OperationMetadata> updateTargetOperationCallable()
Updates the parameters of a single Target.
Sample code:
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
Type | Description |
OperationCallable<UpdateTargetRequest,Target,OperationMetadata> |