Classes
AbandonReleaseRequest
The request object used by AbandonRelease
.
AbandonReleaseResponse
The response object for AbandonRelease
.
AdvanceChildRolloutJob
An advanceChildRollout Job.
AdvanceChildRolloutJobRun
AdvanceChildRolloutJobRun contains information specific to a
advanceChildRollout JobRun
.
AdvanceRolloutRequest
The request object used by AdvanceRollout
.
AdvanceRolloutResponse
The response object from AdvanceRollout
.
AnthosCluster
Information specifying an Anthos Cluster.
ApproveRolloutRequest
The request object used by ApproveRollout
.
ApproveRolloutResponse
The response object from ApproveRollout
.
BuildArtifact
Description of an a image to use during Skaffold rendering.
BuildName
Resource name for the Build
resource.
Canary
Canary represents the canary deployment strategy.
CanaryDeployment
CanaryDeployment represents the canary deployment configuration
CancelRolloutRequest
The request object used by CancelRollout
.
CancelRolloutResponse
The response object from CancelRollout
.
ChildRolloutJobs
ChildRollouts job composition
CloudDeploy
CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).
CloudDeploy.CloudDeployBase
Base class for server-side implementations of CloudDeploy
CloudDeploy.CloudDeployClient
Client for CloudDeploy
CloudDeployClient
CloudDeploy client wrapper, for convenient use.
CloudDeployClientBuilder
Builder class for CloudDeployClient to provide simple configuration of credentials, endpoint etc.
CloudDeployClientImpl
CloudDeploy client wrapper implementation, for convenient use.
CloudDeploySettings
Settings for CloudDeployClient instances.
CloudRunConfig
CloudRunConfig contains the Cloud Run runtime configuration.
CloudRunLocation
Information specifying where to deploy a Cloud Run Service.
CloudRunMetadata
CloudRunMetadata contains information from a Cloud Run deployment.
CloudRunRenderMetadata
CloudRunRenderMetadata contains Cloud Run information associated with a
Release
render.
ClusterName
Resource name for the Cluster
resource.
Config
Service-wide configuration.
ConfigName
Resource name for the Config
resource.
CreateChildRolloutJob
A createChildRollout Job.
CreateChildRolloutJobRun
CreateChildRolloutJobRun contains information specific to a
createChildRollout JobRun
.
CreateDeliveryPipelineRequest
The request object for CreateDeliveryPipeline
.
CreateReleaseRequest
The request object for CreateRelease
,
CreateRolloutRequest
CreateRolloutRequest is the request object used by CreateRollout
.
CreateTargetRequest
The request object for CreateTarget
.
CustomCanaryDeployment
CustomCanaryDeployment represents the custom canary deployment configuration.
CustomCanaryDeployment.Types
Container for nested types declared in the CustomCanaryDeployment message type.
CustomCanaryDeployment.Types.PhaseConfig
PhaseConfig represents the configuration for a phase in the custom canary deployment.
DefaultPool
Execution using the default Cloud Build pool.
DeleteDeliveryPipelineRequest
The request object for DeleteDeliveryPipeline
.
DeleteTargetRequest
The request object for DeleteTarget
.
DeliveryPipeline
A DeliveryPipeline
resource in the Google Cloud Deploy API.
A DeliveryPipeline
defines a pipeline through which a Skaffold
configuration can progress.
DeliveryPipelineName
Resource name for the DeliveryPipeline
resource.
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.
DeployArtifact
The artifacts produced by a deploy operation.
DeployJob
A deploy Job.
DeployJobRun
DeployJobRun contains information specific to a deploy JobRun
.
DeployJobRun.Types
Container for nested types declared in the DeployJobRun message type.
DeployJobRunMetadata
DeployJobRunMetadata surfaces information associated with a DeployJobRun
to
the user.
DeploymentJobs
Deployment job composition.
DeployParameters
DeployParameters contains deploy parameters information.
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
ExecutionConfig.Types
Container for nested types declared in the ExecutionConfig message type.
GetConfigRequest
Request to get a configuration.
GetDeliveryPipelineRequest
The request object for GetDeliveryPipeline
GetJobRunRequest
GetJobRunRequest is the request object used by GetJobRun
.
GetReleaseRequest
The request object for GetRelease
.
GetRolloutRequest
GetRolloutRequest is the request object used by GetRollout
.
GetTargetRequest
The request object for GetTarget
.
GkeCluster
Information specifying a GKE Cluster.
IgnoreJobRequest
The request object used by IgnoreJob
.
IgnoreJobResponse
The response object from IgnoreJob
.
Job
Job represents an operation for a Rollout
.
Job.Types
Container for nested types declared in the Job message type.
JobRun
A JobRun
resource in the Google Cloud Deploy API.
A JobRun
contains information of a single Rollout
job evaluation.
JobRun.Types
Container for nested types declared in the JobRun message type.
JobRunName
Resource name for the JobRun
resource.
JobRunNotificationEvent
Payload proto for "clouddeploy.googleapis.com/jobrun_notification" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.
KubernetesConfig
KubernetesConfig contains the Kubernetes runtime configuration.
KubernetesConfig.Types
Container for nested types declared in the KubernetesConfig message type.
KubernetesConfig.Types.GatewayServiceMesh
Information about the Kubernetes Gateway API service mesh configuration.
KubernetesConfig.Types.ServiceNetworking
Information about the Kubernetes Service networking configuration.
ListDeliveryPipelinesRequest
The request object for ListDeliveryPipelines
.
ListDeliveryPipelinesResponse
The response object from ListDeliveryPipelines
.
ListJobRunsRequest
ListJobRunsRequest is the request object used by ListJobRuns
.
ListJobRunsResponse
ListJobRunsResponse is the response object returned by ListJobRuns
.
ListReleasesRequest
The request object for ListReleases
.
ListReleasesResponse
The response object from ListReleases
.
ListRolloutsRequest
ListRolloutsRequest is the request object used by ListRollouts
.
ListRolloutsResponse
ListRolloutsResponse is the response object reutrned by ListRollouts
.
ListTargetsRequest
The request object for ListTargets
.
ListTargetsResponse
The response object from ListTargets
.
MembershipName
Resource name for the Membership
resource.
Metadata
Metadata includes information associated with a Rollout
.
MultiTarget
Information specifying a multiTarget.
OperationMetadata
Represents the metadata of the long-running operation.
OperationName
Resource name for the Operation
resource.
Phase
Phase represents a collection of jobs that are logically grouped together
for a Rollout
.
Phase.Types
Container for nested types declared in the Phase message type.
PipelineCondition
PipelineCondition contains all conditions relevant to a Delivery Pipeline.
PipelineReadyCondition
PipelineReadyCondition contains information around the status of the Pipeline.
PrivatePool
Execution using a private Cloud Build pool.
Release
A Release
resource in the Google Cloud Deploy API.
A Release
defines a specific Skaffold configuration instance
that can be deployed.
Release.Types
Container for nested types declared in the Release message type.
Release.Types.ReleaseCondition
ReleaseCondition contains all conditions relevant to a Release.
Release.Types.ReleaseReadyCondition
ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.
Release.Types.SkaffoldSupportedCondition
SkaffoldSupportedCondition contains information about when support for the release's version of skaffold ends.
Release.Types.TargetRender
Details of rendering for a single target.
Release.Types.TargetRender.Types
Container for nested types declared in the TargetRender message type.
ReleaseName
Resource name for the Release
resource.
ReleaseNotificationEvent
Payload proto for "clouddeploy.googleapis.com/release_notification" Platform Log event that describes the failure to send release status change Pub/Sub notification.
ReleaseRenderEvent
Payload proto for "clouddeploy.googleapis.com/release_render" Platform Log event that describes the render status change.
RenderMetadata
RenderMetadata includes information associated with a Release
render.
RetryJobRequest
RetryJobRequest is the request object used by RetryJob
.
RetryJobResponse
The response object from 'RetryJob'.
Rollout
A Rollout
resource in the Google Cloud Deploy API.
A Rollout
contains information around a specific deployment to a Target
.
Rollout.Types
Container for nested types declared in the Rollout message type.
RolloutName
Resource name for the Rollout
resource.
RolloutNotificationEvent
Payload proto for "clouddeploy.googleapis.com/rollout_notification" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.
RuntimeConfig
RuntimeConfig contains the runtime specific configurations for a deployment strategy.
SerialPipeline
SerialPipeline defines a sequential set of stages for a DeliveryPipeline
.
ServiceName
Resource name for the Service
resource.
SkaffoldVersion
Details of a supported Skaffold version.
Stage
Stage specifies a location to which to deploy.
Standard
Standard represents the standard deployment strategy.
Strategy
Strategy contains deployment strategy information.
Target
A Target
resource in the Google Cloud Deploy API.
A Target
defines a location to which a Skaffold configuration
can be deployed.
TargetArtifact
The artifacts produced by a target render operation.
TargetArtifact.Types
Container for nested types declared in the TargetArtifact message type.
TargetArtifact.Types.PhaseArtifact
Contains the paths to the artifacts, relative to the URI, for a phase.
TargetName
Resource name for the Target
resource.
TargetNotificationEvent
Payload proto for "clouddeploy.googleapis.com/target_notification" Platform Log event that describes the failure to send target status change Pub/Sub notification.
TargetsPresentCondition
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.
TerminateJobRunRequest
The request object used by TerminateJobRun
.
TerminateJobRunResponse
The response object from TerminateJobRun
.
UpdateDeliveryPipelineRequest
The request object for UpdateDeliveryPipeline
.
UpdateTargetRequest
The request object for UpdateTarget
.
VerifyJob
A verify Job.
VerifyJobRun
VerifyJobRun contains information specific to a verify JobRun
.
VerifyJobRun.Types
Container for nested types declared in the VerifyJobRun message type.
WorkerPoolName
Resource name for the WorkerPool
resource.
Enums
BuildName.ResourceNameType
The possible contents of BuildName.
Canary.ModeOneofCase
Enum of possible cases for the "mode" oneof.
ClusterName.ResourceNameType
The possible contents of ClusterName.
ConfigName.ResourceNameType
The possible contents of ConfigName.
DeliveryPipeline.PipelineOneofCase
Enum of possible cases for the "pipeline" oneof.
DeliveryPipelineName.ResourceNameType
The possible contents of DeliveryPipelineName.
DeployJobRun.Types.FailureCause
Well-known deploy failures.
ExecutionConfig.ExecutionEnvironmentOneofCase
Enum of possible cases for the "execution_environment" oneof.
ExecutionConfig.Types.ExecutionEnvironmentUsage
Possible usages of this configuration.
Job.JobTypeOneofCase
Enum of possible cases for the "job_type" oneof.
Job.Types.State
Valid states of a Job.
JobRun.JobRunOneofCase
Enum of possible cases for the "job_run" oneof.
JobRun.Types.State
Valid states of a JobRun
.
JobRunName.ResourceNameType
The possible contents of JobRunName.
KubernetesConfig.ServiceDefinitionOneofCase
Enum of possible cases for the "service_definition" oneof.
MembershipName.ResourceNameType
The possible contents of MembershipName.
OperationName.ResourceNameType
The possible contents of OperationName.
Phase.JobsOneofCase
Enum of possible cases for the "jobs" oneof.
Phase.Types.State
Valid states of a Phase.
Release.Types.RenderState
Valid states of the render operation.
Release.Types.TargetRender.Types.FailureCause
Well-known rendering failures.
Release.Types.TargetRender.Types.TargetRenderState
Valid states of the render operation.
ReleaseName.ResourceNameType
The possible contents of ReleaseName.
Rollout.Types.ApprovalState
Valid approval states of a Rollout
.
Rollout.Types.FailureCause
Well-known rollout failures.
Rollout.Types.State
Valid states of a Rollout
.
RolloutName.ResourceNameType
The possible contents of RolloutName.
RuntimeConfig.RuntimeConfigOneofCase
Enum of possible cases for the "runtime_config" oneof.
ServiceName.ResourceNameType
The possible contents of ServiceName.
SkaffoldSupportState
The support state of a specific Skaffold version.
Strategy.DeploymentStrategyOneofCase
Enum of possible cases for the "deployment_strategy" oneof.
Target.DeploymentTargetOneofCase
Enum of possible cases for the "deployment_target" oneof.
TargetArtifact.UriOneofCase
Enum of possible cases for the "uri" oneof.
TargetName.ResourceNameType
The possible contents of TargetName.
Type
Type indicates the type of the log entry and can be used as a filter.
VerifyJobRun.Types.FailureCause
Well-known verify failures.
WorkerPoolName.ResourceNameType
The possible contents of WorkerPoolName.