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
.
AdvanceRolloutOperation
Contains the information of an automated advance-rollout operation.
AdvanceRolloutRequest
The request object used by AdvanceRollout
.
AdvanceRolloutResponse
The response object from AdvanceRollout
.
AdvanceRolloutRule
The AdvanceRollout
automation rule will automatically advance a successful
Rollout to the next phase.
AnthosCluster
Information specifying an Anthos Cluster.
ApproveRolloutRequest
The request object used by ApproveRollout
.
ApproveRolloutResponse
The response object from ApproveRollout
.
Automation
An Automation
resource in the Cloud Deploy API.
An Automation
enables the automation of manually driven actions for
a Delivery Pipeline, which includes Release promotion among Targets,
Rollout repair and Rollout deployment strategy advancement. The intention
of Automation is to reduce manual intervention in the continuous delivery
process.
AutomationEvent
Payload proto for "clouddeploy.googleapis.com/automation" Platform Log event that describes the Automation related events.
AutomationName
Resource name for the Automation
resource.
AutomationResourceSelector
AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.
AutomationRolloutMetadata
AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.
AutomationRule
AutomationRule
defines the automation activities.
AutomationRuleCondition
AutomationRuleCondition
contains conditions relevant to an
Automation
rule.
AutomationRun
An AutomationRun
resource in the Cloud Deploy API.
An AutomationRun
represents an execution instance of an
automation rule.
AutomationRun.Types
Container for nested types declared in the AutomationRun message type.
AutomationRunEvent
Payload proto for "clouddeploy.googleapis.com/automation_run" Platform Log event that describes the AutomationRun related events.
AutomationRunName
Resource name for the AutomationRun
resource.
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
CancelAutomationRunRequest
The request object used by CancelAutomationRun
.
CancelAutomationRunResponse
The response object from CancelAutomationRun
.
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.
CreateAutomationRequest
The request object for CreateAutomation
.
CreateChildRolloutJob
A createChildRollout Job.
CreateChildRolloutJobRun
CreateChildRolloutJobRun contains information specific to a
createChildRollout JobRun
.
CreateCustomTargetTypeRequest
The request object for CreateCustomTargetType
.
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.
CustomMetadata
CustomMetadata contains information from a user-defined operation.
CustomTarget
Information specifying a Custom Target.
CustomTargetDeployMetadata
CustomTargetDeployMetadata contains information from a Custom Target deploy operation.
CustomTargetSkaffoldActions
CustomTargetSkaffoldActions represents the CustomTargetType
configuration
using Skaffold custom actions.
CustomTargetType
A CustomTargetType
resource in the Cloud Deploy API.
A CustomTargetType
defines a type of custom target that can be referenced
in a Target
in order to facilitate deploying to other systems besides the
supported runtimes.
CustomTargetTypeName
Resource name for the CustomTargetType
resource.
DefaultPool
Execution using the default Cloud Build pool.
DeleteAutomationRequest
The request object for DeleteAutomation
.
DeleteCustomTargetTypeRequest
The request object for DeleteCustomTargetType
.
DeleteDeliveryPipelineRequest
The request object for DeleteDeliveryPipeline
.
DeleteTargetRequest
The request object for DeleteTarget
.
DeliveryPipeline
A DeliveryPipeline
resource in the 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.
DeployParameters
DeployParameters contains deploy parameters information.
DeploymentJobs
Deployment job composition.
ExecutionConfig
Configuration of the environment to use when calling Skaffold.
ExecutionConfig.Types
Container for nested types declared in the ExecutionConfig message type.
GetAutomationRequest
The request object for GetAutomation
GetAutomationRunRequest
The request object for GetAutomationRun
GetConfigRequest
Request to get a configuration.
GetCustomTargetTypeRequest
The request object for GetCustomTargetType
.
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.
JobName
Resource name for the Job
resource.
JobRun
A JobRun
resource in the 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.
ListAutomationRunsRequest
The request object for ListAutomationRuns
.
ListAutomationRunsResponse
The response object from ListAutomationRuns
.
ListAutomationsRequest
The request object for ListAutomations
.
ListAutomationsResponse
The response object from ListAutomations
.
ListCustomTargetTypesRequest
The request object for ListCustomTargetTypes
.
ListCustomTargetTypesResponse
The response object from ListCustomTargetTypes.
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.
Postdeploy
Postdeploy contains the postdeploy job configuration information.
PostdeployJob
A postdeploy Job.
PostdeployJobRun
PostdeployJobRun contains information specific to a postdeploy JobRun
.
PostdeployJobRun.Types
Container for nested types declared in the PostdeployJobRun message type.
Predeploy
Predeploy contains the predeploy job configuration information.
PredeployJob
A predeploy Job.
PredeployJobRun
PredeployJobRun contains information specific to a predeploy JobRun
.
PredeployJobRun.Types
Container for nested types declared in the PredeployJobRun message type.
PrivatePool
Execution using a private Cloud Build pool.
PromoteReleaseOperation
Contains the information of an automated promote-release operation.
PromoteReleaseRule
PromoteRelease
rule will automatically promote a release from the current
target to a specified target.
Release
A Release
resource in the 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.
RepairMode
Configuration of the repair action.
RepairPhase
RepairPhase tracks the repair attempts that have been made for
each RepairMode
specified in the Automation
resource.
RepairRolloutOperation
Contains the information for an automated repair rollout
operation.
RepairRolloutRule
The RepairRolloutRule
automation rule will automatically repair a failed
Rollout
.
RepositoryName
Resource name for the Repository
resource.
Retry
Retries the failed job.
RetryAttempt
RetryAttempt represents an action of retrying the failed Cloud Deploy job.
RetryJobRequest
RetryJobRequest is the request object used by RetryJob
.
RetryJobResponse
The response object from 'RetryJob'.
RetryPhase
RetryPhase contains the retry attempts and the metadata for initiating a new attempt.
Rollback
Rolls back a Rollout
.
RollbackAttempt
RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.
RollbackTargetConfig
Configs for the Rollback rollout.
RollbackTargetRequest
The request object for RollbackTarget
.
RollbackTargetResponse
The response object from RollbackTarget
.
Rollout
A Rollout
resource in the 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.
RolloutUpdateEvent
Payload proto for "clouddeploy.googleapis.com/rollout_update" Platform Log event that describes the rollout update event.
RolloutUpdateEvent.Types
Container for nested types declared in the RolloutUpdateEvent message type.
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.
SkaffoldModules
Skaffold Config modules and their remote source.
SkaffoldModules.Types
Container for nested types declared in the SkaffoldModules message type.
SkaffoldModules.Types.SkaffoldGCBRepoSource
Cloud Build V2 Repository containing Skaffold Configs.
SkaffoldModules.Types.SkaffoldGCSSource
Cloud Storage bucket containing Skaffold Config modules.
SkaffoldModules.Types.SkaffoldGitSource
Git repository containing Skaffold Config modules.
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 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.
TargetAttribute
Contains criteria for selecting Targets.
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 referenced 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
.
UpdateAutomationRequest
The request object for UpdateAutomation
.
UpdateCustomTargetTypeRequest
The request object for UpdateCustomTargetType
.
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
AutomationName.ResourceNameType
The possible contents of AutomationName.
AutomationRule.RuleOneofCase
Enum of possible cases for the "rule" oneof.
AutomationRun.OperationOneofCase
Enum of possible cases for the "operation" oneof.
AutomationRun.Types.State
Valid state of an AutomationRun
.
AutomationRunName.ResourceNameType
The possible contents of AutomationRunName.
BackoffMode
The pattern of how wait time is increased.
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.
CustomTargetType.DefinitionOneofCase
Enum of possible cases for the "definition" oneof.
CustomTargetTypeName.ResourceNameType
The possible contents of CustomTargetTypeName.
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.
JobName.ResourceNameType
The possible contents of JobName.
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.
PostdeployJobRun.Types.FailureCause
Well-known postdeploy failures.
PredeployJobRun.Types.FailureCause
Well-known predeploy failures.
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.
RepairMode.ModeOneofCase
Enum of possible cases for the "mode" oneof.
RepairPhase.RepairPhaseOneofCase
Enum of possible cases for the "repair_phase" oneof.
RepairState
Valid state of a repair attempt.
RepositoryName.ResourceNameType
The possible contents of RepositoryName.
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.
RolloutUpdateEvent.Types.RolloutUpdateType
RolloutUpdateType indicates the type of the rollout update.
RuntimeConfig.RuntimeConfigOneofCase
Enum of possible cases for the "runtime_config" oneof.
ServiceName.ResourceNameType
The possible contents of ServiceName.
SkaffoldModules.SourceOneofCase
Enum of possible cases for the "source" oneof.
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.