Package com.google.cloud.deploy.v1 (1.12.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:

  1. 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.
  2. 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.
  3. 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

CloudDeployClient.ListTargetsFixedSizeCollection

CloudDeployClient.ListTargetsPage

CloudDeployClient.ListTargetsPagedResponse

CloudDeployGrpc

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

CloudDeployGrpc.CloudDeployBlockingStub

A stub to allow clients to do synchronous rpc calls to service CloudDeploy.

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

CloudDeployGrpc.CloudDeployFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service CloudDeploy.

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

CloudDeployGrpc.CloudDeployImplBase

Base class for the server implementation of the service CloudDeploy.

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

CloudDeployGrpc.CloudDeployStub

A stub to allow clients to do asynchronous rpc calls to service CloudDeploy.

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

CloudDeployProto

CloudDeploySettings

Settings class to configure an instance of CloudDeployClient.

The default instance has everything set to sensible defaults:

  • The default service address (clouddeploy.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDeliveryPipeline to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.Builder cloudDeploySettingsBuilder = CloudDeploySettings.newBuilder();
 cloudDeploySettingsBuilder
     .getDeliveryPipelineSettings()
     .setRetrySettings(
         cloudDeploySettingsBuilder
             .getDeliveryPipelineSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudDeploySettings cloudDeploySettings = cloudDeploySettingsBuilder.build();
 

CloudDeploySettings.Builder

Builder for CloudDeploySettings.

CloudRunConfig

CloudRunConfig contains the Cloud Run runtime configuration.

Protobuf type google.cloud.deploy.v1.CloudRunConfig

CloudRunConfig.Builder

CloudRunConfig contains the Cloud Run runtime configuration.

Protobuf type google.cloud.deploy.v1.CloudRunConfig

CloudRunLocation

Information specifying where to deploy a Cloud Run Service.

Protobuf type google.cloud.deploy.v1.CloudRunLocation

CloudRunLocation.Builder

Information specifying where to deploy a Cloud Run Service.

Protobuf type google.cloud.deploy.v1.CloudRunLocation

CloudRunMetadata

CloudRunMetadata contains information from a Cloud Run deployment.

Protobuf type google.cloud.deploy.v1.CloudRunMetadata

CloudRunMetadata.Builder

CloudRunMetadata contains information from a Cloud Run deployment.

Protobuf type google.cloud.deploy.v1.CloudRunMetadata

CloudRunRenderMetadata

CloudRunRenderMetadata contains Cloud Run information associated with a Release render.

Protobuf type google.cloud.deploy.v1.CloudRunRenderMetadata

CloudRunRenderMetadata.Builder

CloudRunRenderMetadata contains Cloud Run information associated with a Release render.

Protobuf type google.cloud.deploy.v1.CloudRunRenderMetadata

Config

Service-wide configuration.

Protobuf type google.cloud.deploy.v1.Config

Config.Builder

Service-wide configuration.

Protobuf type google.cloud.deploy.v1.Config

ConfigName

ConfigName.Builder

Builder for projects/{project}/locations/{location}/config.

CreateChildRolloutJob

A createChildRollout Job.

Protobuf type google.cloud.deploy.v1.CreateChildRolloutJob

CreateChildRolloutJob.Builder

A createChildRollout Job.

Protobuf type google.cloud.deploy.v1.CreateChildRolloutJob

CreateChildRolloutJobRun

CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.

Protobuf type google.cloud.deploy.v1.CreateChildRolloutJobRun

CreateChildRolloutJobRun.Builder

CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.

Protobuf type google.cloud.deploy.v1.CreateChildRolloutJobRun

CreateDeliveryPipelineRequest

The request object for CreateDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.CreateDeliveryPipelineRequest

CreateDeliveryPipelineRequest.Builder

The request object for CreateDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.CreateDeliveryPipelineRequest

CreateReleaseRequest

The request object for CreateRelease,

Protobuf type google.cloud.deploy.v1.CreateReleaseRequest

CreateReleaseRequest.Builder

The request object for CreateRelease,

Protobuf type google.cloud.deploy.v1.CreateReleaseRequest

CreateRolloutRequest

CreateRolloutRequest is the request object used by CreateRollout.

Protobuf type google.cloud.deploy.v1.CreateRolloutRequest

CreateRolloutRequest.Builder

CreateRolloutRequest is the request object used by CreateRollout.

Protobuf type google.cloud.deploy.v1.CreateRolloutRequest

CreateTargetRequest

The request object for CreateTarget.

Protobuf type google.cloud.deploy.v1.CreateTargetRequest

CreateTargetRequest.Builder

The request object for CreateTarget.

Protobuf type google.cloud.deploy.v1.CreateTargetRequest

CustomCanaryDeployment

CustomCanaryDeployment represents the custom canary deployment configuration.

Protobuf type google.cloud.deploy.v1.CustomCanaryDeployment

CustomCanaryDeployment.Builder

CustomCanaryDeployment represents the custom canary deployment configuration.

Protobuf type google.cloud.deploy.v1.CustomCanaryDeployment

CustomCanaryDeployment.PhaseConfig

PhaseConfig represents the configuration for a phase in the custom canary deployment.

Protobuf type google.cloud.deploy.v1.CustomCanaryDeployment.PhaseConfig

CustomCanaryDeployment.PhaseConfig.Builder

PhaseConfig represents the configuration for a phase in the custom canary deployment.

Protobuf type google.cloud.deploy.v1.CustomCanaryDeployment.PhaseConfig

DefaultPool

Execution using the default Cloud Build pool.

Protobuf type google.cloud.deploy.v1.DefaultPool

DefaultPool.Builder

Execution using the default Cloud Build pool.

Protobuf type google.cloud.deploy.v1.DefaultPool

DeleteDeliveryPipelineRequest

The request object for DeleteDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.DeleteDeliveryPipelineRequest

DeleteDeliveryPipelineRequest.Builder

The request object for DeleteDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.DeleteDeliveryPipelineRequest

DeleteTargetRequest

The request object for DeleteTarget.

Protobuf type google.cloud.deploy.v1.DeleteTargetRequest

DeleteTargetRequest.Builder

The request object for DeleteTarget.

Protobuf type google.cloud.deploy.v1.DeleteTargetRequest

DeliveryPipeline

A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Protobuf type google.cloud.deploy.v1.DeliveryPipeline

DeliveryPipeline.Builder

A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Protobuf type google.cloud.deploy.v1.DeliveryPipeline

DeliveryPipelineName

DeliveryPipelineName.Builder

Builder for projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

DeliveryPipelineNotificationEvent

Payload proto for "clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.DeliveryPipelineNotificationEvent

DeliveryPipelineNotificationEvent.Builder

Payload proto for "clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.DeliveryPipelineNotificationEvent

DeliveryPipelineNotificationPayloadProto

DeployJob

A deploy Job.

Protobuf type google.cloud.deploy.v1.DeployJob

DeployJob.Builder

A deploy Job.

Protobuf type google.cloud.deploy.v1.DeployJob

DeployJobRun

DeployJobRun contains information specific to a deploy JobRun.

Protobuf type google.cloud.deploy.v1.DeployJobRun

DeployJobRun.Builder

DeployJobRun contains information specific to a deploy JobRun.

Protobuf type google.cloud.deploy.v1.DeployJobRun

DeployJobRunMetadata

DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.

Protobuf type google.cloud.deploy.v1.DeployJobRunMetadata

DeployJobRunMetadata.Builder

DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.

Protobuf type google.cloud.deploy.v1.DeployJobRunMetadata

DeploymentJobs

Deployment job composition.

Protobuf type google.cloud.deploy.v1.DeploymentJobs

DeploymentJobs.Builder

Deployment job composition.

Protobuf type google.cloud.deploy.v1.DeploymentJobs

ExecutionConfig

Configuration of the environment to use when calling Skaffold.

Protobuf type google.cloud.deploy.v1.ExecutionConfig

ExecutionConfig.Builder

Configuration of the environment to use when calling Skaffold.

Protobuf type google.cloud.deploy.v1.ExecutionConfig

GetConfigRequest

Request to get a configuration.

Protobuf type google.cloud.deploy.v1.GetConfigRequest

GetConfigRequest.Builder

Request to get a configuration.

Protobuf type google.cloud.deploy.v1.GetConfigRequest

GetDeliveryPipelineRequest

The request object for GetDeliveryPipeline

Protobuf type google.cloud.deploy.v1.GetDeliveryPipelineRequest

GetDeliveryPipelineRequest.Builder

The request object for GetDeliveryPipeline

Protobuf type google.cloud.deploy.v1.GetDeliveryPipelineRequest

GetJobRunRequest

GetJobRunRequest is the request object used by GetJobRun.

Protobuf type google.cloud.deploy.v1.GetJobRunRequest

GetJobRunRequest.Builder

GetJobRunRequest is the request object used by GetJobRun.

Protobuf type google.cloud.deploy.v1.GetJobRunRequest

GetReleaseRequest

The request object for GetRelease.

Protobuf type google.cloud.deploy.v1.GetReleaseRequest

GetReleaseRequest.Builder

The request object for GetRelease.

Protobuf type google.cloud.deploy.v1.GetReleaseRequest

GetRolloutRequest

GetRolloutRequest is the request object used by GetRollout.

Protobuf type google.cloud.deploy.v1.GetRolloutRequest

GetRolloutRequest.Builder

GetRolloutRequest is the request object used by GetRollout.

Protobuf type google.cloud.deploy.v1.GetRolloutRequest

GetTargetRequest

The request object for GetTarget.

Protobuf type google.cloud.deploy.v1.GetTargetRequest

GetTargetRequest.Builder

The request object for GetTarget.

Protobuf type google.cloud.deploy.v1.GetTargetRequest

GkeCluster

Information specifying a GKE Cluster.

Protobuf type google.cloud.deploy.v1.GkeCluster

GkeCluster.Builder

Information specifying a GKE Cluster.

Protobuf type google.cloud.deploy.v1.GkeCluster

IgnoreJobRequest

The request object used by IgnoreJob.

Protobuf type google.cloud.deploy.v1.IgnoreJobRequest

IgnoreJobRequest.Builder

The request object used by IgnoreJob.

Protobuf type google.cloud.deploy.v1.IgnoreJobRequest

IgnoreJobResponse

The response object from IgnoreJob.

Protobuf type google.cloud.deploy.v1.IgnoreJobResponse

IgnoreJobResponse.Builder

The response object from IgnoreJob.

Protobuf type google.cloud.deploy.v1.IgnoreJobResponse

Job

Job represents an operation for a Rollout.

Protobuf type google.cloud.deploy.v1.Job

Job.Builder

Job represents an operation for a Rollout.

Protobuf type google.cloud.deploy.v1.Job

JobRun

A JobRun resource in the Google Cloud Deploy API. A JobRun contains information of a single Rollout job evaluation.

Protobuf type google.cloud.deploy.v1.JobRun

JobRun.Builder

A JobRun resource in the Google Cloud Deploy API. A JobRun contains information of a single Rollout job evaluation.

Protobuf type google.cloud.deploy.v1.JobRun

JobRunName

JobRunName.Builder

Builder for projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}.

JobRunNotificationEvent

Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.JobRunNotificationEvent

JobRunNotificationEvent.Builder

Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.JobRunNotificationEvent

JobRunNotificationPayloadProto

KubernetesConfig

KubernetesConfig contains the Kubernetes runtime configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig

KubernetesConfig.Builder

KubernetesConfig contains the Kubernetes runtime configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig

KubernetesConfig.GatewayServiceMesh

Information about the Kubernetes Gateway API service mesh configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh

KubernetesConfig.GatewayServiceMesh.Builder

Information about the Kubernetes Gateway API service mesh configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh

KubernetesConfig.ServiceNetworking

Information about the Kubernetes Service networking configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig.ServiceNetworking

KubernetesConfig.ServiceNetworking.Builder

Information about the Kubernetes Service networking configuration.

Protobuf type google.cloud.deploy.v1.KubernetesConfig.ServiceNetworking

ListDeliveryPipelinesRequest

The request object for ListDeliveryPipelines.

Protobuf type google.cloud.deploy.v1.ListDeliveryPipelinesRequest

ListDeliveryPipelinesRequest.Builder

The request object for ListDeliveryPipelines.

Protobuf type google.cloud.deploy.v1.ListDeliveryPipelinesRequest

ListDeliveryPipelinesResponse

The response object from ListDeliveryPipelines.

Protobuf type google.cloud.deploy.v1.ListDeliveryPipelinesResponse

ListDeliveryPipelinesResponse.Builder

The response object from ListDeliveryPipelines.

Protobuf type google.cloud.deploy.v1.ListDeliveryPipelinesResponse

ListJobRunsRequest

ListJobRunsRequest is the request object used by ListJobRuns.

Protobuf type google.cloud.deploy.v1.ListJobRunsRequest

ListJobRunsRequest.Builder

ListJobRunsRequest is the request object used by ListJobRuns.

Protobuf type google.cloud.deploy.v1.ListJobRunsRequest

ListJobRunsResponse

ListJobRunsResponse is the response object returned by ListJobRuns.

Protobuf type google.cloud.deploy.v1.ListJobRunsResponse

ListJobRunsResponse.Builder

ListJobRunsResponse is the response object returned by ListJobRuns.

Protobuf type google.cloud.deploy.v1.ListJobRunsResponse

ListReleasesRequest

The request object for ListReleases.

Protobuf type google.cloud.deploy.v1.ListReleasesRequest

ListReleasesRequest.Builder

The request object for ListReleases.

Protobuf type google.cloud.deploy.v1.ListReleasesRequest

ListReleasesResponse

The response object from ListReleases.

Protobuf type google.cloud.deploy.v1.ListReleasesResponse

ListReleasesResponse.Builder

The response object from ListReleases.

Protobuf type google.cloud.deploy.v1.ListReleasesResponse

ListRolloutsRequest

ListRolloutsRequest is the request object used by ListRollouts.

Protobuf type google.cloud.deploy.v1.ListRolloutsRequest

ListRolloutsRequest.Builder

ListRolloutsRequest is the request object used by ListRollouts.

Protobuf type google.cloud.deploy.v1.ListRolloutsRequest

ListRolloutsResponse

ListRolloutsResponse is the response object reutrned by ListRollouts.

Protobuf type google.cloud.deploy.v1.ListRolloutsResponse

ListRolloutsResponse.Builder

ListRolloutsResponse is the response object reutrned by ListRollouts.

Protobuf type google.cloud.deploy.v1.ListRolloutsResponse

ListTargetsRequest

The request object for ListTargets.

Protobuf type google.cloud.deploy.v1.ListTargetsRequest

ListTargetsRequest.Builder

The request object for ListTargets.

Protobuf type google.cloud.deploy.v1.ListTargetsRequest

ListTargetsResponse

The response object from ListTargets.

Protobuf type google.cloud.deploy.v1.ListTargetsResponse

ListTargetsResponse.Builder

The response object from ListTargets.

Protobuf type google.cloud.deploy.v1.ListTargetsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LogEnumsProto

Metadata

Metadata includes information associated with a Rollout.

Protobuf type google.cloud.deploy.v1.Metadata

Metadata.Builder

Metadata includes information associated with a Rollout.

Protobuf type google.cloud.deploy.v1.Metadata

MultiTarget

Information specifying a multiTarget.

Protobuf type google.cloud.deploy.v1.MultiTarget

MultiTarget.Builder

Information specifying a multiTarget.

Protobuf type google.cloud.deploy.v1.MultiTarget

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.deploy.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.deploy.v1.OperationMetadata

Phase

Phase represents a collection of jobs that are logically grouped together for a Rollout.

Protobuf type google.cloud.deploy.v1.Phase

Phase.Builder

Phase represents a collection of jobs that are logically grouped together for a Rollout.

Protobuf type google.cloud.deploy.v1.Phase

PipelineCondition

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

Protobuf type google.cloud.deploy.v1.PipelineCondition

PipelineCondition.Builder

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

Protobuf type google.cloud.deploy.v1.PipelineCondition

PipelineReadyCondition

PipelineReadyCondition contains information around the status of the Pipeline.

Protobuf type google.cloud.deploy.v1.PipelineReadyCondition

PipelineReadyCondition.Builder

PipelineReadyCondition contains information around the status of the Pipeline.

Protobuf type google.cloud.deploy.v1.PipelineReadyCondition

PrivatePool

Execution using a private Cloud Build pool.

Protobuf type google.cloud.deploy.v1.PrivatePool

PrivatePool.Builder

Execution using a private Cloud Build pool.

Protobuf type google.cloud.deploy.v1.PrivatePool

Release

A Release resource in the Google Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.

Protobuf type google.cloud.deploy.v1.Release

Release.Builder

A Release resource in the Google Cloud Deploy API. A Release defines a specific Skaffold configuration instance that can be deployed.

Protobuf type google.cloud.deploy.v1.Release

Release.ReleaseCondition

ReleaseCondition contains all conditions relevant to a Release.

Protobuf type google.cloud.deploy.v1.Release.ReleaseCondition

Release.ReleaseCondition.Builder

ReleaseCondition contains all conditions relevant to a Release.

Protobuf type google.cloud.deploy.v1.Release.ReleaseCondition

Release.ReleaseReadyCondition

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

Protobuf type google.cloud.deploy.v1.Release.ReleaseReadyCondition

Release.ReleaseReadyCondition.Builder

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

Protobuf type google.cloud.deploy.v1.Release.ReleaseReadyCondition

Release.SkaffoldSupportedCondition

SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.

Protobuf type google.cloud.deploy.v1.Release.SkaffoldSupportedCondition

Release.SkaffoldSupportedCondition.Builder

SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.

Protobuf type google.cloud.deploy.v1.Release.SkaffoldSupportedCondition

Release.TargetRender

Details of rendering for a single target.

Protobuf type google.cloud.deploy.v1.Release.TargetRender

Release.TargetRender.Builder

Details of rendering for a single target.

Protobuf type google.cloud.deploy.v1.Release.TargetRender

ReleaseName

ReleaseName.Builder

Builder for projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

ReleaseNotificationEvent

Payload proto for "clouddeploy.googleapis.com/release_notification" Platform Log event that describes the failure to send release status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.ReleaseNotificationEvent

ReleaseNotificationEvent.Builder

Payload proto for "clouddeploy.googleapis.com/release_notification" Platform Log event that describes the failure to send release status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.ReleaseNotificationEvent

ReleaseNotificationPayloadProto

ReleaseRenderEvent

Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.

Protobuf type google.cloud.deploy.v1.ReleaseRenderEvent

ReleaseRenderEvent.Builder

Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.

Protobuf type google.cloud.deploy.v1.ReleaseRenderEvent

ReleaseRenderPayloadProto

RenderMetadata

RenderMetadata includes information associated with a Release render.

Protobuf type google.cloud.deploy.v1.RenderMetadata

RenderMetadata.Builder

RenderMetadata includes information associated with a Release render.

Protobuf type google.cloud.deploy.v1.RenderMetadata

RetryJobRequest

RetryJobRequest is the request object used by RetryJob.

Protobuf type google.cloud.deploy.v1.RetryJobRequest

RetryJobRequest.Builder

RetryJobRequest is the request object used by RetryJob.

Protobuf type google.cloud.deploy.v1.RetryJobRequest

RetryJobResponse

The response object from 'RetryJob'.

Protobuf type google.cloud.deploy.v1.RetryJobResponse

RetryJobResponse.Builder

The response object from 'RetryJob'.

Protobuf type google.cloud.deploy.v1.RetryJobResponse

Rollout

A Rollout resource in the Google Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Protobuf type google.cloud.deploy.v1.Rollout

Rollout.Builder

A Rollout resource in the Google Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Protobuf type google.cloud.deploy.v1.Rollout

RolloutName

RolloutName.Builder

Builder for projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}.

RolloutNotificationEvent

Payload proto for "clouddeploy.googleapis.com/rollout_notification" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.RolloutNotificationEvent

RolloutNotificationEvent.Builder

Payload proto for "clouddeploy.googleapis.com/rollout_notification" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.RolloutNotificationEvent

RolloutNotificationPayloadProto

RuntimeConfig

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

Protobuf type google.cloud.deploy.v1.RuntimeConfig

RuntimeConfig.Builder

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

Protobuf type google.cloud.deploy.v1.RuntimeConfig

SerialPipeline

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Protobuf type google.cloud.deploy.v1.SerialPipeline

SerialPipeline.Builder

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Protobuf type google.cloud.deploy.v1.SerialPipeline

SkaffoldVersion

Details of a supported Skaffold version.

Protobuf type google.cloud.deploy.v1.SkaffoldVersion

SkaffoldVersion.Builder

Details of a supported Skaffold version.

Protobuf type google.cloud.deploy.v1.SkaffoldVersion

Stage

Stage specifies a location to which to deploy.

Protobuf type google.cloud.deploy.v1.Stage

Stage.Builder

Stage specifies a location to which to deploy.

Protobuf type google.cloud.deploy.v1.Stage

Standard

Standard represents the standard deployment strategy.

Protobuf type google.cloud.deploy.v1.Standard

Standard.Builder

Standard represents the standard deployment strategy.

Protobuf type google.cloud.deploy.v1.Standard

Strategy

Strategy contains deployment strategy information.

Protobuf type google.cloud.deploy.v1.Strategy

Strategy.Builder

Strategy contains deployment strategy information.

Protobuf type google.cloud.deploy.v1.Strategy

Target

A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

Protobuf type google.cloud.deploy.v1.Target

Target.Builder

A Target resource in the Google Cloud Deploy API. A Target defines a location to which a Skaffold configuration can be deployed.

Protobuf type google.cloud.deploy.v1.Target

TargetArtifact

The artifacts produced by a target render operation.

Protobuf type google.cloud.deploy.v1.TargetArtifact

TargetArtifact.Builder

The artifacts produced by a target render operation.

Protobuf type google.cloud.deploy.v1.TargetArtifact

TargetArtifact.PhaseArtifact

Contains the paths to the artifacts, relative to the URI, for a phase.

Protobuf type google.cloud.deploy.v1.TargetArtifact.PhaseArtifact

TargetArtifact.PhaseArtifact.Builder

Contains the paths to the artifacts, relative to the URI, for a phase.

Protobuf type google.cloud.deploy.v1.TargetArtifact.PhaseArtifact

TargetName

TargetName.Builder

Builder for projects/{project}/locations/{location}/targets/{target}.

TargetNotificationEvent

Payload proto for "clouddeploy.googleapis.com/target_notification" Platform Log event that describes the failure to send target status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.TargetNotificationEvent

TargetNotificationEvent.Builder

Payload proto for "clouddeploy.googleapis.com/target_notification" Platform Log event that describes the failure to send target status change Pub/Sub notification.

Protobuf type google.cloud.deploy.v1.TargetNotificationEvent

TargetNotificationPayloadProto

TargetsPresentCondition

TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.

Protobuf type google.cloud.deploy.v1.TargetsPresentCondition

TargetsPresentCondition.Builder

TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.

Protobuf type google.cloud.deploy.v1.TargetsPresentCondition

TargetsTypeCondition

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

Protobuf type google.cloud.deploy.v1.TargetsTypeCondition

TargetsTypeCondition.Builder

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

Protobuf type google.cloud.deploy.v1.TargetsTypeCondition

TerminateJobRunRequest

The request object used by TerminateJobRun.

Protobuf type google.cloud.deploy.v1.TerminateJobRunRequest

TerminateJobRunRequest.Builder

The request object used by TerminateJobRun.

Protobuf type google.cloud.deploy.v1.TerminateJobRunRequest

TerminateJobRunResponse

The response object from TerminateJobRun.

Protobuf type google.cloud.deploy.v1.TerminateJobRunResponse

TerminateJobRunResponse.Builder

The response object from TerminateJobRun.

Protobuf type google.cloud.deploy.v1.TerminateJobRunResponse

UpdateDeliveryPipelineRequest

The request object for UpdateDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.UpdateDeliveryPipelineRequest

UpdateDeliveryPipelineRequest.Builder

The request object for UpdateDeliveryPipeline.

Protobuf type google.cloud.deploy.v1.UpdateDeliveryPipelineRequest

UpdateTargetRequest

The request object for UpdateTarget.

Protobuf type google.cloud.deploy.v1.UpdateTargetRequest

UpdateTargetRequest.Builder

The request object for UpdateTarget.

Protobuf type google.cloud.deploy.v1.UpdateTargetRequest

VerifyJob

A verify Job.

Protobuf type google.cloud.deploy.v1.VerifyJob

VerifyJob.Builder

A verify Job.

Protobuf type google.cloud.deploy.v1.VerifyJob

VerifyJobRun

VerifyJobRun contains information specific to a verify JobRun.

Protobuf type google.cloud.deploy.v1.VerifyJobRun

VerifyJobRun.Builder

VerifyJobRun contains information specific to a verify JobRun.

Protobuf type google.cloud.deploy.v1.VerifyJobRun

Interfaces

AbandonReleaseRequestOrBuilder

AbandonReleaseResponseOrBuilder

AdvanceChildRolloutJobOrBuilder

AdvanceChildRolloutJobRunOrBuilder

AdvanceRolloutRequestOrBuilder

AdvanceRolloutResponseOrBuilder

AnthosClusterOrBuilder

ApproveRolloutRequestOrBuilder

ApproveRolloutResponseOrBuilder

BuildArtifactOrBuilder

CanaryDeploymentOrBuilder

CanaryOrBuilder

CancelRolloutRequestOrBuilder

CancelRolloutResponseOrBuilder

ChildRolloutJobsOrBuilder

CloudDeployGrpc.AsyncService

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

CloudRunConfigOrBuilder

CloudRunLocationOrBuilder

CloudRunMetadataOrBuilder

CloudRunRenderMetadataOrBuilder

ConfigOrBuilder

CreateChildRolloutJobOrBuilder

CreateChildRolloutJobRunOrBuilder

CreateDeliveryPipelineRequestOrBuilder

CreateReleaseRequestOrBuilder

CreateRolloutRequestOrBuilder

CreateTargetRequestOrBuilder

CustomCanaryDeployment.PhaseConfigOrBuilder

CustomCanaryDeploymentOrBuilder

DefaultPoolOrBuilder

DeleteDeliveryPipelineRequestOrBuilder

DeleteTargetRequestOrBuilder

DeliveryPipelineNotificationEventOrBuilder

DeliveryPipelineOrBuilder

DeployJobOrBuilder

DeployJobRunMetadataOrBuilder

DeployJobRunOrBuilder

DeploymentJobsOrBuilder

ExecutionConfigOrBuilder

GetConfigRequestOrBuilder

GetDeliveryPipelineRequestOrBuilder

GetJobRunRequestOrBuilder

GetReleaseRequestOrBuilder

GetRolloutRequestOrBuilder

GetTargetRequestOrBuilder

GkeClusterOrBuilder

IgnoreJobRequestOrBuilder

IgnoreJobResponseOrBuilder

JobOrBuilder

JobRunNotificationEventOrBuilder

JobRunOrBuilder

KubernetesConfig.GatewayServiceMeshOrBuilder

KubernetesConfig.ServiceNetworkingOrBuilder

KubernetesConfigOrBuilder

ListDeliveryPipelinesRequestOrBuilder

ListDeliveryPipelinesResponseOrBuilder

ListJobRunsRequestOrBuilder

ListJobRunsResponseOrBuilder

ListReleasesRequestOrBuilder

ListReleasesResponseOrBuilder

ListRolloutsRequestOrBuilder

ListRolloutsResponseOrBuilder

ListTargetsRequestOrBuilder

ListTargetsResponseOrBuilder

MetadataOrBuilder

MultiTargetOrBuilder

OperationMetadataOrBuilder

PhaseOrBuilder

PipelineConditionOrBuilder

PipelineReadyConditionOrBuilder

PrivatePoolOrBuilder

Release.ReleaseConditionOrBuilder

Release.ReleaseReadyConditionOrBuilder

Release.SkaffoldSupportedConditionOrBuilder

Release.TargetRenderOrBuilder

ReleaseNotificationEventOrBuilder

ReleaseOrBuilder

ReleaseRenderEventOrBuilder

RenderMetadataOrBuilder

RetryJobRequestOrBuilder

RetryJobResponseOrBuilder

RolloutNotificationEventOrBuilder

RolloutOrBuilder

RuntimeConfigOrBuilder

SerialPipelineOrBuilder

SkaffoldVersionOrBuilder

StageOrBuilder

StandardOrBuilder

StrategyOrBuilder

TargetArtifact.PhaseArtifactOrBuilder

TargetArtifactOrBuilder

TargetNotificationEventOrBuilder

TargetOrBuilder

TargetsPresentConditionOrBuilder

TargetsTypeConditionOrBuilder

TerminateJobRunRequestOrBuilder

TerminateJobRunResponseOrBuilder

UpdateDeliveryPipelineRequestOrBuilder

UpdateTargetRequestOrBuilder

VerifyJobOrBuilder

VerifyJobRunOrBuilder

Enums

Canary.ModeCase

DeliveryPipeline.PipelineCase

DeployJobRun.FailureCause

Well-known deploy failures.

Protobuf enum google.cloud.deploy.v1.DeployJobRun.FailureCause

ExecutionConfig.ExecutionEnvironmentCase

ExecutionConfig.ExecutionEnvironmentUsage

Possible usages of this configuration.

Protobuf enum google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage

Job.JobTypeCase

Job.State

Valid states of a Job.

Protobuf enum google.cloud.deploy.v1.Job.State

JobRun.JobRunCase

JobRun.State

Valid states of a JobRun.

Protobuf enum google.cloud.deploy.v1.JobRun.State

KubernetesConfig.ServiceDefinitionCase

Phase.JobsCase

Phase.State

Valid states of a Phase.

Protobuf enum google.cloud.deploy.v1.Phase.State

Release.RenderState

Valid states of the render operation.

Protobuf enum google.cloud.deploy.v1.Release.RenderState

Release.TargetRender.FailureCause

Well-known rendering failures.

Protobuf enum google.cloud.deploy.v1.Release.TargetRender.FailureCause

Release.TargetRender.TargetRenderState

Valid states of the render operation.

Protobuf enum google.cloud.deploy.v1.Release.TargetRender.TargetRenderState

Rollout.ApprovalState

Valid approval states of a Rollout.

Protobuf enum google.cloud.deploy.v1.Rollout.ApprovalState

Rollout.FailureCause

Well-known rollout failures.

Protobuf enum google.cloud.deploy.v1.Rollout.FailureCause

Rollout.State

Valid states of a Rollout.

Protobuf enum google.cloud.deploy.v1.Rollout.State

RuntimeConfig.RuntimeConfigCase

SkaffoldSupportState

The support state of a specific Skaffold version.

Protobuf enum google.cloud.deploy.v1.SkaffoldSupportState

Strategy.DeploymentStrategyCase

Target.DeploymentTargetCase

TargetArtifact.UriCase

Type

Type indicates the type of the log entry and can be used as a filter.

Protobuf enum google.cloud.deploy.v1.Type

VerifyJobRun.FailureCause

Well-known verify failures.

Protobuf enum google.cloud.deploy.v1.VerifyJobRun.FailureCause