@Generated("by gapic-generator-java")
Package com.google.cloud.deploy.v1
A client to 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);
}
-
Class Summary Class Description AbandonReleaseRequest The request object used by `AbandonRelease`.AbandonReleaseRequest.Builder The request object used by `AbandonRelease`.AbandonReleaseResponse The response object for `AbandonRelease`.AbandonReleaseResponse.Builder The response object for `AbandonRelease`.AdvanceChildRolloutJob An advanceChildRollout Job.AdvanceChildRolloutJob.Builder An advanceChildRollout Job.AdvanceChildRolloutJobRun AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`.AdvanceChildRolloutJobRun.Builder AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`.AdvanceRolloutRequest The request object used by `AdvanceRollout`.AdvanceRolloutRequest.Builder The request object used by `AdvanceRollout`.AdvanceRolloutResponse The response object from `AdvanceRollout`.AdvanceRolloutResponse.Builder The response object from `AdvanceRollout`.AnthosCluster Information specifying an Anthos Cluster.AnthosCluster.Builder Information specifying an Anthos Cluster.ApproveRolloutRequest The request object used by `ApproveRollout`.ApproveRolloutRequest.Builder The request object used by `ApproveRollout`.ApproveRolloutResponse The response object from `ApproveRollout`.ApproveRolloutResponse.Builder The response object from `ApproveRollout`.BuildArtifact Description of an a image to use during Skaffold rendering.BuildArtifact.Builder Description of an a image to use during Skaffold rendering.Canary Canary represents the canary deployment strategy.Canary.Builder Canary represents the canary deployment strategy.CanaryDeployment CanaryDeployment represents the canary deployment configurationCanaryDeployment.Builder CanaryDeployment represents the canary deployment configurationCancelRolloutRequest The request object used by `CancelRollout`.CancelRolloutRequest.Builder The request object used by `CancelRollout`.CancelRolloutResponse The response object from `CancelRollout`.CancelRolloutResponse.Builder The response object from `CancelRollout`.ChildRolloutJobs ChildRollouts job compositionChildRolloutJobs.Builder ChildRollouts job compositionCloudDeployClient Service Description: CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).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.CloudDeployGrpc.CloudDeployFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CloudDeploy.CloudDeployGrpc.CloudDeployImplBase Base class for the server implementation of the service CloudDeploy.CloudDeployGrpc.CloudDeployStub A stub to allow clients to do asynchronous rpc calls to service CloudDeploy.CloudDeployProto CloudDeploySettings Settings class to configure an instance ofCloudDeployClient
.CloudDeploySettings.Builder Builder for CloudDeploySettings.CloudRunConfig CloudRunConfig contains the Cloud Run runtime configuration.CloudRunConfig.Builder CloudRunConfig contains the Cloud Run runtime configuration.CloudRunLocation Information specifying where to deploy a Cloud Run Service.CloudRunLocation.Builder Information specifying where to deploy a Cloud Run Service.CloudRunMetadata CloudRunMetadata contains information from a Cloud Run deployment.CloudRunMetadata.Builder CloudRunMetadata contains information from a Cloud Run deployment.CloudRunRenderMetadata CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render.CloudRunRenderMetadata.Builder CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render.Config Service-wide configuration.Config.Builder Service-wide configuration.ConfigName ConfigName.Builder Builder for projects/{project}/locations/{location}/config.CreateChildRolloutJob A createChildRollout Job.CreateChildRolloutJob.Builder A createChildRollout Job.CreateChildRolloutJobRun CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`.CreateChildRolloutJobRun.Builder CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`.CreateDeliveryPipelineRequest The request object for `CreateDeliveryPipeline`.CreateDeliveryPipelineRequest.Builder The request object for `CreateDeliveryPipeline`.CreateReleaseRequest The request object for `CreateRelease`,CreateReleaseRequest.Builder The request object for `CreateRelease`,CreateRolloutRequest CreateRolloutRequest is the request object used by `CreateRollout`.CreateRolloutRequest.Builder CreateRolloutRequest is the request object used by `CreateRollout`.CreateTargetRequest The request object for `CreateTarget`.CreateTargetRequest.Builder The request object for `CreateTarget`.CustomCanaryDeployment CustomCanaryDeployment represents the custom canary deployment configuration.CustomCanaryDeployment.Builder CustomCanaryDeployment represents the custom canary deployment configuration.CustomCanaryDeployment.PhaseConfig PhaseConfig represents the configuration for a phase in the custom canary deployment.CustomCanaryDeployment.PhaseConfig.Builder PhaseConfig represents the configuration for a phase in the custom canary deployment.DefaultPool Execution using the default Cloud Build pool.DefaultPool.Builder Execution using the default Cloud Build pool.DeleteDeliveryPipelineRequest The request object for `DeleteDeliveryPipeline`.DeleteDeliveryPipelineRequest.Builder The request object for `DeleteDeliveryPipeline`.DeleteTargetRequest The request object for `DeleteTarget`.DeleteTargetRequest.Builder The request object for `DeleteTarget`.DeliveryPipeline A `DeliveryPipeline` resource in the Cloud Deploy API.DeliveryPipeline.Builder A `DeliveryPipeline` resource in the Cloud Deploy API.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.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.DeliveryPipelineNotificationPayloadProto DeployArtifact The artifacts produced by a deploy operation.DeployArtifact.Builder The artifacts produced by a deploy operation.DeployJob A deploy Job.DeployJob.Builder A deploy Job.DeployJobRun DeployJobRun contains information specific to a deploy `JobRun`.DeployJobRun.Builder DeployJobRun contains information specific to a deploy `JobRun`.DeployJobRunMetadata DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user.DeployJobRunMetadata.Builder DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user.DeploymentJobs Deployment job composition.DeploymentJobs.Builder Deployment job composition.DeployParameters DeployParameters contains deploy parameters information.DeployParameters.Builder DeployParameters contains deploy parameters information.ExecutionConfig Configuration of the environment to use when calling Skaffold.ExecutionConfig.Builder Configuration of the environment to use when calling Skaffold.GetConfigRequest Request to get a configuration.GetConfigRequest.Builder Request to get a configuration.GetDeliveryPipelineRequest The request object for `GetDeliveryPipeline`GetDeliveryPipelineRequest.Builder The request object for `GetDeliveryPipeline`GetJobRunRequest GetJobRunRequest is the request object used by `GetJobRun`.GetJobRunRequest.Builder GetJobRunRequest is the request object used by `GetJobRun`.GetReleaseRequest The request object for `GetRelease`.GetReleaseRequest.Builder The request object for `GetRelease`.GetRolloutRequest GetRolloutRequest is the request object used by `GetRollout`.GetRolloutRequest.Builder GetRolloutRequest is the request object used by `GetRollout`.GetTargetRequest The request object for `GetTarget`.GetTargetRequest.Builder The request object for `GetTarget`.GkeCluster Information specifying a GKE Cluster.GkeCluster.Builder Information specifying a GKE Cluster.IgnoreJobRequest The request object used by `IgnoreJob`.IgnoreJobRequest.Builder The request object used by `IgnoreJob`.IgnoreJobResponse The response object from `IgnoreJob`.IgnoreJobResponse.Builder The response object from `IgnoreJob`.Job Job represents an operation for a `Rollout`.Job.Builder Job represents an operation for a `Rollout`.JobRun A `JobRun` resource in the Cloud Deploy API.JobRun.Builder A `JobRun` resource in the Cloud Deploy API.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.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.JobRunNotificationPayloadProto KubernetesConfig KubernetesConfig contains the Kubernetes runtime configuration.KubernetesConfig.Builder KubernetesConfig contains the Kubernetes runtime configuration.KubernetesConfig.GatewayServiceMesh Information about the Kubernetes Gateway API service mesh configuration.KubernetesConfig.GatewayServiceMesh.Builder Information about the Kubernetes Gateway API service mesh configuration.KubernetesConfig.ServiceNetworking Information about the Kubernetes Service networking configuration.KubernetesConfig.ServiceNetworking.Builder Information about the Kubernetes Service networking configuration.ListDeliveryPipelinesRequest The request object for `ListDeliveryPipelines`.ListDeliveryPipelinesRequest.Builder The request object for `ListDeliveryPipelines`.ListDeliveryPipelinesResponse The response object from `ListDeliveryPipelines`.ListDeliveryPipelinesResponse.Builder The response object from `ListDeliveryPipelines`.ListJobRunsRequest ListJobRunsRequest is the request object used by `ListJobRuns`.ListJobRunsRequest.Builder ListJobRunsRequest is the request object used by `ListJobRuns`.ListJobRunsResponse ListJobRunsResponse is the response object returned by `ListJobRuns`.ListJobRunsResponse.Builder ListJobRunsResponse is the response object returned by `ListJobRuns`.ListReleasesRequest The request object for `ListReleases`.ListReleasesRequest.Builder The request object for `ListReleases`.ListReleasesResponse The response object from `ListReleases`.ListReleasesResponse.Builder The response object from `ListReleases`.ListRolloutsRequest ListRolloutsRequest is the request object used by `ListRollouts`.ListRolloutsRequest.Builder ListRolloutsRequest is the request object used by `ListRollouts`.ListRolloutsResponse ListRolloutsResponse is the response object reutrned by `ListRollouts`.ListRolloutsResponse.Builder ListRolloutsResponse is the response object reutrned by `ListRollouts`.ListTargetsRequest The request object for `ListTargets`.ListTargetsRequest.Builder The request object for `ListTargets`.ListTargetsResponse The response object from `ListTargets`.ListTargetsResponse.Builder The response object from `ListTargets`.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.LogEnumsProto Metadata Metadata includes information associated with a `Rollout`.Metadata.Builder Metadata includes information associated with a `Rollout`.MultiTarget Information specifying a multiTarget.MultiTarget.Builder Information specifying a multiTarget.OperationMetadata Represents the metadata of the long-running operation.OperationMetadata.Builder Represents the metadata of the long-running operation.Phase Phase represents a collection of jobs that are logically grouped together for a `Rollout`.Phase.Builder Phase represents a collection of jobs that are logically grouped together for a `Rollout`.PipelineCondition PipelineCondition contains all conditions relevant to a Delivery Pipeline.PipelineCondition.Builder PipelineCondition contains all conditions relevant to a Delivery Pipeline.PipelineReadyCondition PipelineReadyCondition contains information around the status of the Pipeline.PipelineReadyCondition.Builder PipelineReadyCondition contains information around the status of the Pipeline.Postdeploy Postdeploy contains the postdeploy job configuration information.Postdeploy.Builder Postdeploy contains the postdeploy job configuration information.PostdeployJob A postdeploy Job.PostdeployJob.Builder A postdeploy Job.PostdeployJobRun PostdeployJobRun contains information specific to a postdeploy `JobRun`.PostdeployJobRun.Builder PostdeployJobRun contains information specific to a postdeploy `JobRun`.Predeploy Predeploy contains the predeploy job configuration information.Predeploy.Builder Predeploy contains the predeploy job configuration information.PredeployJob A predeploy Job.PredeployJob.Builder A predeploy Job.PredeployJobRun PredeployJobRun contains information specific to a predeploy `JobRun`.PredeployJobRun.Builder PredeployJobRun contains information specific to a predeploy `JobRun`.PrivatePool Execution using a private Cloud Build pool.PrivatePool.Builder Execution using a private Cloud Build pool.Release A `Release` resource in the Cloud Deploy API.Release.Builder A `Release` resource in the Cloud Deploy API.Release.ReleaseCondition ReleaseCondition contains all conditions relevant to a Release.Release.ReleaseCondition.Builder ReleaseCondition contains all conditions relevant to a Release.Release.ReleaseReadyCondition ReleaseReadyCondition contains information around the status of the Release.Release.ReleaseReadyCondition.Builder ReleaseReadyCondition contains information around the status of the Release.Release.SkaffoldSupportedCondition SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.Release.SkaffoldSupportedCondition.Builder SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.Release.TargetRender Details of rendering for a single target.Release.TargetRender.Builder Details of rendering for a single target.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.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.ReleaseNotificationPayloadProto ReleaseRenderEvent Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.ReleaseRenderEvent.Builder Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.ReleaseRenderPayloadProto RenderMetadata RenderMetadata includes information associated with a `Release` render.RenderMetadata.Builder RenderMetadata includes information associated with a `Release` render.RetryJobRequest RetryJobRequest is the request object used by `RetryJob`.RetryJobRequest.Builder RetryJobRequest is the request object used by `RetryJob`.RetryJobResponse The response object from 'RetryJob'.RetryJobResponse.Builder The response object from 'RetryJob'.Rollout A `Rollout` resource in the Cloud Deploy API.Rollout.Builder A `Rollout` resource in the Cloud Deploy API.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.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.RolloutNotificationPayloadProto RuntimeConfig RuntimeConfig contains the runtime specific configurations for a deployment strategy.RuntimeConfig.Builder RuntimeConfig contains the runtime specific configurations for a deployment strategy.SerialPipeline SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.SerialPipeline.Builder SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.SkaffoldVersion Details of a supported Skaffold version.SkaffoldVersion.Builder Details of a supported Skaffold version.Stage Stage specifies a location to which to deploy.Stage.Builder Stage specifies a location to which to deploy.Standard Standard represents the standard deployment strategy.Standard.Builder Standard represents the standard deployment strategy.Strategy Strategy contains deployment strategy information.Strategy.Builder Strategy contains deployment strategy information.Target A `Target` resource in the Cloud Deploy API.Target.Builder A `Target` resource in the Cloud Deploy API.TargetArtifact The artifacts produced by a target render operation.TargetArtifact.Builder The artifacts produced by a target render operation.TargetArtifact.PhaseArtifact Contains the paths to the artifacts, relative to the URI, for a phase.TargetArtifact.PhaseArtifact.Builder Contains the paths to the artifacts, relative to the URI, for a phase.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.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.TargetNotificationPayloadProto TargetsPresentCondition TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.TargetsPresentCondition.Builder TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist.TargetsTypeCondition TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.TargetsTypeCondition.Builder TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.TerminateJobRunRequest The request object used by `TerminateJobRun`.TerminateJobRunRequest.Builder The request object used by `TerminateJobRun`.TerminateJobRunResponse The response object from `TerminateJobRun`.TerminateJobRunResponse.Builder The response object from `TerminateJobRun`.UpdateDeliveryPipelineRequest The request object for `UpdateDeliveryPipeline`.UpdateDeliveryPipelineRequest.Builder The request object for `UpdateDeliveryPipeline`.UpdateTargetRequest The request object for `UpdateTarget`.UpdateTargetRequest.Builder The request object for `UpdateTarget`.VerifyJob A verify Job.VerifyJob.Builder A verify Job.VerifyJobRun VerifyJobRun contains information specific to a verify `JobRun`.VerifyJobRun.Builder VerifyJobRun contains information specific to a verify `JobRun`.