Package com.google.cloud.deploy.v1 (1.13.0)

A client to Google Cloud Deploy API

The interfaces provided are listed below, along with usage samples.

CloudDeployClient

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

Sample for CloudDeployClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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);
 }

Classes

AbandonReleaseRequest

The request object used by AbandonRelease.

Protobuf type google.cloud.deploy.v1.AbandonReleaseRequest

AbandonReleaseRequest.Builder

The request object used by AbandonRelease.

Protobuf type google.cloud.deploy.v1.AbandonReleaseRequest

AbandonReleaseResponse

The response object for AbandonRelease.

Protobuf type google.cloud.deploy.v1.AbandonReleaseResponse

AbandonReleaseResponse.Builder

The response object for AbandonRelease.

Protobuf type google.cloud.deploy.v1.AbandonReleaseResponse

AdvanceChildRolloutJob

An advanceChildRollout Job.

Protobuf type google.cloud.deploy.v1.AdvanceChildRolloutJob

AdvanceChildRolloutJob.Builder

An advanceChildRollout Job.

Protobuf type google.cloud.deploy.v1.AdvanceChildRolloutJob

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.

Protobuf type google.cloud.deploy.v1.AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun.Builder

AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.

Protobuf type google.cloud.deploy.v1.AdvanceChildRolloutJobRun

AdvanceRolloutRequest

The request object used by AdvanceRollout.

Protobuf type google.cloud.deploy.v1.AdvanceRolloutRequest

AdvanceRolloutRequest.Builder

The request object used by AdvanceRollout.

Protobuf type google.cloud.deploy.v1.AdvanceRolloutRequest

AdvanceRolloutResponse

The response object from AdvanceRollout.

Protobuf type google.cloud.deploy.v1.AdvanceRolloutResponse

AdvanceRolloutResponse.Builder

The response object from AdvanceRollout.

Protobuf type google.cloud.deploy.v1.AdvanceRolloutResponse

AnthosCluster

Information specifying an Anthos Cluster.

Protobuf type google.cloud.deploy.v1.AnthosCluster

AnthosCluster.Builder

Information specifying an Anthos Cluster.

Protobuf type google.cloud.deploy.v1.AnthosCluster

ApproveRolloutRequest

The request object used by ApproveRollout.

Protobuf type google.cloud.deploy.v1.ApproveRolloutRequest

ApproveRolloutRequest.Builder

The request object used by ApproveRollout.

Protobuf type google.cloud.deploy.v1.ApproveRolloutRequest

ApproveRolloutResponse

The response object from ApproveRollout.

Protobuf type google.cloud.deploy.v1.ApproveRolloutResponse

ApproveRolloutResponse.Builder

The response object from ApproveRollout.

Protobuf type google.cloud.deploy.v1.ApproveRolloutResponse

BuildArtifact

Description of an a image to use during Skaffold rendering.

Protobuf type google.cloud.deploy.v1.BuildArtifact

BuildArtifact.Builder

Description of an a image to use during Skaffold rendering.

Protobuf type google.cloud.deploy.v1.BuildArtifact

Canary

Canary represents the canary deployment strategy.

Protobuf type google.cloud.deploy.v1.Canary

Canary.Builder

Canary represents the canary deployment strategy.

Protobuf type google.cloud.deploy.v1.Canary

CanaryDeployment

CanaryDeployment represents the canary deployment configuration

Protobuf type google.cloud.deploy.v1.CanaryDeployment

CanaryDeployment.Builder

CanaryDeployment represents the canary deployment configuration

Protobuf type google.cloud.deploy.v1.CanaryDeployment

CancelRolloutRequest

The request object used by CancelRollout.

Protobuf type google.cloud.deploy.v1.CancelRolloutRequest

CancelRolloutRequest.Builder

The request object used by CancelRollout.

Protobuf type google.cloud.deploy.v1.CancelRolloutRequest

CancelRolloutResponse

The response object from CancelRollout.

Protobuf type google.cloud.deploy.v1.CancelRolloutResponse

CancelRolloutResponse.Builder

The response object from CancelRollout.

Protobuf type google.cloud.deploy.v1.CancelRolloutResponse

ChildRolloutJobs

ChildRollouts job composition

Protobuf type google.cloud.deploy.v1.ChildRolloutJobs

ChildRolloutJobs.Builder

ChildRollouts job composition

Protobuf type google.cloud.deploy.v1.ChildRolloutJobs

CloudDeployClient

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().

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.

CloudDeployClient.ListDeliveryPipelinesFixedSizeCollection

CloudDeployClient.ListDeliveryPipelinesPage

CloudDeployClient.ListDeliveryPipelinesPagedResponse

CloudDeployClient.ListJobRunsFixedSizeCollection

CloudDeployClient.ListJobRunsPage

CloudDeployClient.ListJobRunsPagedResponse

CloudDeployClient.ListLocationsFixedSizeCollection

CloudDeployClient.ListLocationsPage

CloudDeployClient.ListLocationsPagedResponse

CloudDeployClient.ListReleasesFixedSizeCollection

CloudDeployClient.ListReleasesPage

CloudDeployClient.ListReleasesPagedResponse

CloudDeployClient.ListRolloutsFixedSizeCollection

CloudDeployClient.ListRolloutsPage

CloudDeployClient.ListRolloutsPagedResponse