Package Classes (2.6.3) Stay organized with collections Save and categorize content based on your preferences.
Summary of entries of Classes for clouddeploy.
Classes
CloudDeployAsyncClient
CloudDeploy service creates and manages Continuous Deliveryoperations on Google Cloud Platform via Skaffold(https://skaffold.dev).
CloudDeployClient
CloudDeploy service creates and manages Continuous Deliveryoperations on Google Cloud Platform via Skaffold(https://skaffold.dev).
ListAutomationRunsAsyncPager
A pager for iterating throughlist_automation_runs requests.
This class thinly wraps an initialListAutomationRunsResponse object, andprovides an__aiter__ method to iterate through itsautomation_runs field.
If there are more pages, the__aiter__ method will make additionalListAutomationRuns requests and continue to iteratethrough theautomation_runs field on thecorresponding responses.
All the usualListAutomationRunsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListAutomationRunsPager
A pager for iterating throughlist_automation_runs requests.
This class thinly wraps an initialListAutomationRunsResponse object, andprovides an__iter__ method to iterate through itsautomation_runs field.
If there are more pages, the__iter__ method will make additionalListAutomationRuns requests and continue to iteratethrough theautomation_runs field on thecorresponding responses.
All the usualListAutomationRunsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListAutomationsAsyncPager
A pager for iterating throughlist_automations requests.
This class thinly wraps an initialListAutomationsResponse object, andprovides an__aiter__ method to iterate through itsautomations field.
If there are more pages, the__aiter__ method will make additionalListAutomations requests and continue to iteratethrough theautomations field on thecorresponding responses.
All the usualListAutomationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListAutomationsPager
A pager for iterating throughlist_automations requests.
This class thinly wraps an initialListAutomationsResponse object, andprovides an__iter__ method to iterate through itsautomations field.
If there are more pages, the__iter__ method will make additionalListAutomations requests and continue to iteratethrough theautomations field on thecorresponding responses.
All the usualListAutomationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListCustomTargetTypesAsyncPager
A pager for iterating throughlist_custom_target_types requests.
This class thinly wraps an initialListCustomTargetTypesResponse object, andprovides an__aiter__ method to iterate through itscustom_target_types field.
If there are more pages, the__aiter__ method will make additionalListCustomTargetTypes requests and continue to iteratethrough thecustom_target_types field on thecorresponding responses.
All the usualListCustomTargetTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListCustomTargetTypesPager
A pager for iterating throughlist_custom_target_types requests.
This class thinly wraps an initialListCustomTargetTypesResponse object, andprovides an__iter__ method to iterate through itscustom_target_types field.
If there are more pages, the__iter__ method will make additionalListCustomTargetTypes requests and continue to iteratethrough thecustom_target_types field on thecorresponding responses.
All the usualListCustomTargetTypesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListDeliveryPipelinesAsyncPager
A pager for iterating throughlist_delivery_pipelines requests.
This class thinly wraps an initialListDeliveryPipelinesResponse object, andprovides an__aiter__ method to iterate through itsdelivery_pipelines field.
If there are more pages, the__aiter__ method will make additionalListDeliveryPipelines requests and continue to iteratethrough thedelivery_pipelines field on thecorresponding responses.
All the usualListDeliveryPipelinesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListDeliveryPipelinesPager
A pager for iterating throughlist_delivery_pipelines requests.
This class thinly wraps an initialListDeliveryPipelinesResponse object, andprovides an__iter__ method to iterate through itsdelivery_pipelines field.
If there are more pages, the__iter__ method will make additionalListDeliveryPipelines requests and continue to iteratethrough thedelivery_pipelines field on thecorresponding responses.
All the usualListDeliveryPipelinesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListDeployPoliciesAsyncPager
A pager for iterating throughlist_deploy_policies requests.
This class thinly wraps an initialListDeployPoliciesResponse object, andprovides an__aiter__ method to iterate through itsdeploy_policies field.
If there are more pages, the__aiter__ method will make additionalListDeployPolicies requests and continue to iteratethrough thedeploy_policies field on thecorresponding responses.
All the usualListDeployPoliciesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListDeployPoliciesPager
A pager for iterating throughlist_deploy_policies requests.
This class thinly wraps an initialListDeployPoliciesResponse object, andprovides an__iter__ method to iterate through itsdeploy_policies field.
If there are more pages, the__iter__ method will make additionalListDeployPolicies requests and continue to iteratethrough thedeploy_policies field on thecorresponding responses.
All the usualListDeployPoliciesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListJobRunsAsyncPager
A pager for iterating throughlist_job_runs requests.
This class thinly wraps an initialListJobRunsResponse object, andprovides an__aiter__ method to iterate through itsjob_runs field.
If there are more pages, the__aiter__ method will make additionalListJobRuns requests and continue to iteratethrough thejob_runs field on thecorresponding responses.
All the usualListJobRunsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListJobRunsPager
A pager for iterating throughlist_job_runs requests.
This class thinly wraps an initialListJobRunsResponse object, andprovides an__iter__ method to iterate through itsjob_runs field.
If there are more pages, the__iter__ method will make additionalListJobRuns requests and continue to iteratethrough thejob_runs field on thecorresponding responses.
All the usualListJobRunsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReleasesAsyncPager
A pager for iterating throughlist_releases requests.
This class thinly wraps an initialListReleasesResponse object, andprovides an__aiter__ method to iterate through itsreleases field.
If there are more pages, the__aiter__ method will make additionalListReleases requests and continue to iteratethrough thereleases field on thecorresponding responses.
All the usualListReleasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReleasesPager
A pager for iterating throughlist_releases requests.
This class thinly wraps an initialListReleasesResponse object, andprovides an__iter__ method to iterate through itsreleases field.
If there are more pages, the__iter__ method will make additionalListReleases requests and continue to iteratethrough thereleases field on thecorresponding responses.
All the usualListReleasesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListRolloutsAsyncPager
A pager for iterating throughlist_rollouts requests.
This class thinly wraps an initialListRolloutsResponse object, andprovides an__aiter__ method to iterate through itsrollouts field.
If there are more pages, the__aiter__ method will make additionalListRollouts requests and continue to iteratethrough therollouts field on thecorresponding responses.
All the usualListRolloutsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListRolloutsPager
A pager for iterating throughlist_rollouts requests.
This class thinly wraps an initialListRolloutsResponse object, andprovides an__iter__ method to iterate through itsrollouts field.
If there are more pages, the__iter__ method will make additionalListRollouts requests and continue to iteratethrough therollouts field on thecorresponding responses.
All the usualListRolloutsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListTargetsAsyncPager
A pager for iterating throughlist_targets requests.
This class thinly wraps an initialListTargetsResponse object, andprovides an__aiter__ method to iterate through itstargets field.
If there are more pages, the__aiter__ method will make additionalListTargets requests and continue to iteratethrough thetargets field on thecorresponding responses.
All the usualListTargetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListTargetsPager
A pager for iterating throughlist_targets requests.
This class thinly wraps an initialListTargetsResponse object, andprovides an__iter__ method to iterate through itstargets field.
If there are more pages, the__iter__ method will make additionalListTargets requests and continue to iteratethrough thetargets field on thecorresponding responses.
All the usualListTargetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AbandonReleaseRequest
The request object used byAbandonRelease.
AbandonReleaseResponse
The response object forAbandonRelease.
AdvanceChildRolloutJob
An advanceChildRollout Job.
AdvanceChildRolloutJobRun
AdvanceChildRolloutJobRun contains information specific to aadvanceChildRolloutJobRun.
AdvanceRolloutOperation
Contains the information of an automated advance-rolloutoperation.
AdvanceRolloutRequest
The request object used byAdvanceRollout.
AdvanceRolloutResponse
The response object fromAdvanceRollout.
AdvanceRolloutRule
TheAdvanceRollout automation rule will automatically advance asuccessful Rollout to the next phase.
AnthosCluster
Information specifying an Anthos Cluster.
ApproveRolloutRequest
The request object used byApproveRollout.
ApproveRolloutResponse
The response object fromApproveRollout.
AssociatedEntities
Information about entities associated with aTarget.
Automation
AnAutomation resource in the Cloud Deploy API.
AnAutomation enables the automation of manually driven actionsfor a Delivery Pipeline, which includes Release promotion amongTargets, Rollout repair and Rollout deployment strategy advancement.The intention of Automation is to reduce manual intervention in thecontinuous delivery process.
AnnotationsEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
AutomationEvent
Payload proto for "clouddeploy.googleapis.com/automation"Platform Log event that describes the Automation related events.
AutomationResourceSelector
AutomationResourceSelector contains the information to selectthe resources to which an Automation is going to be applied.
AutomationRolloutMetadata
AutomationRolloutMetadata contains Automation-related actionsthat were performed on a rollout.
AutomationRule
AutomationRule defines the automation activities.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AutomationRuleCondition
AutomationRuleCondition contains conditions relevant to anAutomation rule.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AutomationRun
AnAutomationRun resource in the Cloud Deploy API.
AnAutomationRun represents an execution instance of anautomation rule.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Valid state of anAutomationRun.
AutomationRunEvent
Payload proto for "clouddeploy.googleapis.com/automation_run"Platform Log event that describes the AutomationRun related events.
BackoffMode
The pattern of how wait time is increased.
BuildArtifact
Description of an a image to use during Skaffold rendering.
Canary
Canary represents the canary deployment strategy.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CanaryDeployment
CanaryDeployment represents the canary deploymentconfiguration
CancelAutomationRunRequest
The request object used byCancelAutomationRun.
CancelAutomationRunResponse
The response object fromCancelAutomationRun.
CancelRolloutRequest
The request object used byCancelRollout.
CancelRolloutResponse
The response object fromCancelRollout.
ChildRolloutJobs
ChildRollouts job composition
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 Rundeployment.
CloudRunRenderMetadata
CloudRunRenderMetadata contains Cloud Run information associatedwith aRelease render.
Config
Service-wide configuration.
CreateAutomationRequest
The request object forCreateAutomation.
CreateChildRolloutJob
A createChildRollout Job.
CreateChildRolloutJobRun
CreateChildRolloutJobRun contains information specific to acreateChildRolloutJobRun.
CreateCustomTargetTypeRequest
The request object forCreateCustomTargetType.
CreateDeliveryPipelineRequest
The request object forCreateDeliveryPipeline.
CreateDeployPolicyRequest
The request object forCreateDeployPolicy.
CreateReleaseRequest
The request object forCreateRelease,
CreateRolloutRequest
CreateRolloutRequest is the request object used byCreateRollout.
CreateTargetRequest
The request object forCreateTarget.
CustomCanaryDeployment
CustomCanaryDeployment represents the custom canarydeployment configuration.
PhaseConfig
PhaseConfig represents the configuration for a phase in thecustom canary deployment.
CustomMetadata
CustomMetadata contains information from a user-definedoperation.
ValuesEntry
The abstract base class for a message.
CustomTarget
Information specifying a Custom Target.
CustomTargetDeployMetadata
CustomTargetDeployMetadata contains information from a CustomTarget deploy operation.
CustomTargetSkaffoldActions
CustomTargetSkaffoldActions represents theCustomTargetTypeconfiguration using Skaffold custom actions.
CustomTargetType
ACustomTargetType resource in the Cloud Deploy API.
ACustomTargetType defines a type of custom target that can bereferenced in aTarget in order to facilitate deploying to othersystems besides the supported runtimes.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnnotationsEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
CustomTargetTypeNotificationEvent
Payload proto for"clouddeploy.googleapis.com/customtargettype_notification" PlatformLog event that describes the failure to send a custom target typestatus change Pub/Sub notification.
DefaultPool
Execution using the default Cloud Build pool.
DeleteAutomationRequest
The request object forDeleteAutomation.
DeleteCustomTargetTypeRequest
The request object forDeleteCustomTargetType.
DeleteDeliveryPipelineRequest
The request object forDeleteDeliveryPipeline.
DeleteDeployPolicyRequest
The request object forDeleteDeployPolicy.
DeleteTargetRequest
The request object forDeleteTarget.
DeliveryPipeline
ADeliveryPipeline resource in the Cloud Deploy API.
ADeliveryPipeline defines a pipeline through which a Skaffoldconfiguration can progress.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnnotationsEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
DeliveryPipelineAttribute
Contains criteria for selecting DeliveryPipelines.
LabelsEntry
The abstract base class for a message.
DeliveryPipelineNotificationEvent
Payload proto for"clouddeploy.googleapis.com/deliverypipeline_notification" PlatformLog event that describes the failure to send delivery pipelinestatus change Pub/Sub notification.
DeployArtifact
The artifacts produced by a deploy operation.
DeployJob
A deploy Job.
DeployJobRun
DeployJobRun contains information specific to a deployJobRun.
FailureCause
Well-known deploy failures.
DeployJobRunMetadata
DeployJobRunMetadata surfaces information associated with aDeployJobRun to the user.
DeployParameters
DeployParameters contains deploy parameters information.
MatchTargetLabelsEntry
The abstract base class for a message.
ValuesEntry
The abstract base class for a message.
DeployPolicy
ADeployPolicy resource in the Cloud Deploy API.
ADeployPolicy inhibits manual or automation-driven actionswithin a Delivery Pipeline or Target.
AnnotationsEntry
The abstract base class for a message.
Invoker
What invoked the action. Filters enforcing the policydepending on what invoked the action.
LabelsEntry
The abstract base class for a message.
DeployPolicyEvaluationEvent
Payload proto for"clouddeploy.googleapis.com/deploypolicy_evaluation" Platform Logevent that describes the deploy policy evaluation event.
PolicyVerdict
The policy verdict of the request.
PolicyVerdictOverride
Things that could have overridden the policy verdict. When overridesare used, the request will be allowed even if it isDENIED_BY_POLICY.
DeployPolicyNotificationEvent
Payload proto for"clouddeploy.googleapis.com/deploypolicy_notification". Platform Logevent that describes the failure to send a pub/sub notification whenthere is a DeployPolicy status change.
DeployPolicyResourceSelector
Contains information on the resources to select for a deploypolicy. Attributes provided must all match the resource in orderfor policy restrictions to apply. For example, if deliverypipelines attributes given are an id "prod" and labels "foo:bar", a delivery pipeline resource must match both that id andhave that label in order to be subject to the policy.
DeploymentJobs
Deployment job composition.
ExecutionConfig
Configuration of the environment to use when callingSkaffold.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExecutionEnvironmentUsage
Possible usages of this configuration.
GetAutomationRequest
The request object forGetAutomation
GetAutomationRunRequest
The request object forGetAutomationRun
GetConfigRequest
Request to get a configuration.
GetCustomTargetTypeRequest
The request object forGetCustomTargetType.
GetDeliveryPipelineRequest
The request object forGetDeliveryPipeline
GetDeployPolicyRequest
The request object forGetDeployPolicy
GetJobRunRequest
GetJobRunRequest is the request object used byGetJobRun.
GetReleaseRequest
The request object forGetRelease.
GetRolloutRequest
GetRolloutRequest is the request object used byGetRollout.
GetTargetRequest
The request object forGetTarget.
GkeCluster
Information specifying a GKE Cluster.
IgnoreJobRequest
The request object used byIgnoreJob.
IgnoreJobResponse
The response object fromIgnoreJob.
Job
Job represents an operation for aRollout.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Valid states of a Job.
JobRun
AJobRun resource in the Cloud Deploy API.
AJobRun contains information of a singleRollout jobevaluation.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Valid states of aJobRun.
JobRunNotificationEvent
Payload proto for "clouddeploy.googleapis.com/jobrun_notification"Platform Log event that describes the failure to send JobRunresource update Pub/Sub notification.
KubernetesConfig
KubernetesConfig contains the Kubernetes runtimeconfiguration.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GatewayServiceMesh
Information about the Kubernetes Gateway API service meshconfiguration.
RouteDestinations
Information about route destinations for the Gateway APIservice mesh.
ServiceNetworking
Information about the Kubernetes Service networkingconfiguration.
ListAutomationRunsRequest
The request object forListAutomationRuns.
ListAutomationRunsResponse
The response object fromListAutomationRuns.
ListAutomationsRequest
The request object forListAutomations.
ListAutomationsResponse
The response object fromListAutomations.
ListCustomTargetTypesRequest
The request object forListCustomTargetTypes.
ListCustomTargetTypesResponse
The response object fromListCustomTargetTypes.
ListDeliveryPipelinesRequest
The request object forListDeliveryPipelines.
ListDeliveryPipelinesResponse
The response object fromListDeliveryPipelines.
ListDeployPoliciesRequest
The request object forListDeployPolicies.
ListDeployPoliciesResponse
The response object fromListDeployPolicies.
ListJobRunsRequest
ListJobRunsRequest is the request object used byListJobRuns.
ListJobRunsResponse
ListJobRunsResponse is the response object returned byListJobRuns.
ListReleasesRequest
The request object forListReleases.
ListReleasesResponse
The response object fromListReleases.
ListRolloutsRequest
ListRolloutsRequest is the request object used byListRollouts.
ListRolloutsResponse
ListRolloutsResponse is the response object returned byListRollouts.
ListTargetsRequest
The request object forListTargets.
ListTargetsResponse
The response object fromListTargets.
Metadata
Metadata includes information associated with aRollout.
MultiTarget
Information specifying a multiTarget.
OneTimeWindow
One-time window within which actions are restricted. Forexample, blocking actions over New Year's Eve from December 31stat 5pm to January 1st at 9am.
OperationMetadata
Represents the metadata of the long-running operation.
Phase
Phase represents a collection of jobs that are logically groupedtogether for aRollout.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
Valid states of a Phase.
PipelineCondition
PipelineCondition contains all conditions relevant to aDelivery Pipeline.
PipelineReadyCondition
PipelineReadyCondition contains information around the statusof the Pipeline.
PolicyRule
Deploy Policy rule.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PolicyViolation
Returned from an action if one or more policies wereviolated, and therefore the action was prevented. Containsinformation about what policies were violated and why.
PolicyViolationDetails
Policy violation details.
Postdeploy
Postdeploy contains the postdeploy job configurationinformation.
PostdeployJob
A postdeploy Job.
PostdeployJobRun
PostdeployJobRun contains information specific to a postdeployJobRun.
FailureCause
Well-known postdeploy failures.
Predeploy
Predeploy contains the predeploy job configurationinformation.
PredeployJob
A predeploy Job.
PredeployJobRun
PredeployJobRun contains information specific to a predeployJobRun.
FailureCause
Well-known predeploy failures.
PrivatePool
Execution using a private Cloud Build pool.
PromoteReleaseOperation
Contains the information of an automated promote-releaseoperation.
PromoteReleaseRule
ThePromoteRelease rule will automatically promote a releasefrom the current target to a specified target.
Release
ARelease resource in the Cloud Deploy API.
ARelease defines a specific Skaffold configuration instancethat can be deployed.
AnnotationsEntry
The abstract base class for a message.
DeployParametersEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
ReleaseCondition
ReleaseCondition contains all conditions relevant to aRelease.
ReleaseReadyCondition
ReleaseReadyCondition contains information around the statusof the Release. If a release is not ready, you cannot create arollout with the release.
RenderState
Valid states of the render operation.
SkaffoldSupportedCondition
SkaffoldSupportedCondition contains information about whensupport for the release's version of Skaffold ends.
TargetArtifactsEntry
The abstract base class for a message.
TargetRender
Details of rendering for a single target.
FailureCause
Well-known rendering failures.
TargetRenderState
Valid states of the render operation.
TargetRendersEntry
The abstract base class for a message.
ReleaseNotificationEvent
Payload proto for "clouddeploy.googleapis.com/release_notification"Platform Log event that describes the failure to send release statuschange 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 aReleaserender.
RepairPhase
RepairPhase tracks the repair attempts that have been made for eachRepairPhaseConfig specified in theAutomation resource.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RepairPhaseConfig
Configuration of the repair phase.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RepairRolloutOperation
Contains the information for an automatedrepair rolloutoperation.
RepairRolloutRule
TheRepairRolloutRule automation rule will automatically repaira failedRollout.
RepairState
Valid state of a repair attempt.
Retry
Retries the failed job.
RetryAttempt
RetryAttempt represents an action of retrying the failedCloud Deploy job.
RetryJobRequest
RetryJobRequest is the request object used byRetryJob.
RetryJobResponse
The response object from 'RetryJob'.
RetryPhase
RetryPhase contains the retry attempts and the metadata forinitiating a new attempt.
Rollback
Rolls back aRollout.
RollbackAttempt
RollbackAttempt represents an action of rolling back a CloudDeploy 'Target'.
RollbackTargetConfig
Configs for the Rollback rollout.
RollbackTargetRequest
The request object forRollbackTarget.
RollbackTargetResponse
The response object fromRollbackTarget.
Rollout
ARollout resource in the Cloud Deploy API.
ARollout contains information around a specific deployment to aTarget.
AnnotationsEntry
The abstract base class for a message.
ApprovalState
Valid approval states of aRollout.
FailureCause
Well-known rollout failures.
LabelsEntry
The abstract base class for a message.
State
Valid states of aRollout.
RolloutNotificationEvent
Payload proto for "clouddeploy.googleapis.com/rollout_notification"Platform Log event that describes the failure to send rollout statuschange Pub/Sub notification.
RolloutRestriction
Rollout restrictions.
RolloutActions
Rollout actions to be restricted as part of the policy.
RolloutUpdateEvent
Payload proto for "clouddeploy.googleapis.com/rollout_update"Platform Log event that describes the rollout update event.
RolloutUpdateType
RolloutUpdateType indicates the type of the rollout update.
RuntimeConfig
RuntimeConfig contains the runtime specific configurationsfor a deployment strategy.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SerialPipeline
SerialPipeline defines a sequential set of stages for aDeliveryPipeline.
SkaffoldModules
Skaffold Config modules and their remote source.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SkaffoldGCBRepoSource
Cloud Build V2 Repository containing Skaffold Configs.
SkaffoldGCSSource
Cloud Storage bucket containing Skaffold Config modules.
SkaffoldGitSource
Git repository containing Skaffold Config modules.
SkaffoldSupportState
The support state of a specific Skaffold version.
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.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Target
ATarget resource in the Cloud Deploy API.
ATarget defines a location to which a Skaffold configurationcan be deployed.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnnotationsEntry
The abstract base class for a message.
AssociatedEntitiesEntry
The abstract base class for a message.
DeployParametersEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
TargetArtifact
The artifacts produced by a target render operation.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PhaseArtifact
Contains the paths to the artifacts, relative to the URI, fora phase.
PhaseArtifactsEntry
The abstract base class for a message.
TargetAttribute
Contains criteria for selecting Targets. This could be usedto select targets for a Deploy Policy or for an Automation.
LabelsEntry
The abstract base class for a message.
TargetNotificationEvent
Payload proto for "clouddeploy.googleapis.com/target_notification"Platform Log event that describes the failure to send target statuschange Pub/Sub notification.
TargetsPresentCondition
TargetsPresentCondition contains information on any Targetsreferenced in the Delivery Pipeline that do not actually exist.
TargetsTypeCondition
TargetsTypeCondition contains information on whether theTargets defined in the Delivery Pipeline are of the same type.
TerminateJobRunRequest
The request object used byTerminateJobRun.
TerminateJobRunResponse
The response object fromTerminateJobRun.
TimeWindows
Time windows within which actions are restricted. See thedocumentation <https://cloud.google.com/deploy/docs/deploy-policy#dates_times>__for more information on how to configure dates/times.
TimedPromoteReleaseCondition
TimedPromoteReleaseCondition contains conditions specific to anAutomation with a Timed Promote Release rule defined.
Targets
The targets involved in a single timed promotion.
TimedPromoteReleaseOperation
Contains the information of an automated timedpromote-release operation.
TimedPromoteReleaseRule
TheTimedPromoteReleaseRule will automatically promote a releasefrom the current target(s) to the specified target(s) on aconfigured schedule.
Type
Type indicates the type of the log entry and can be used as afilter.
UpdateAutomationRequest
The request object forUpdateAutomation.
UpdateCustomTargetTypeRequest
The request object forUpdateCustomTargetType.
UpdateDeliveryPipelineRequest
The request object forUpdateDeliveryPipeline.
UpdateDeployPolicyRequest
The request object forUpdateDeployPolicy.
UpdateTargetRequest
The request object forUpdateTarget.
VerifyJob
A verify Job.
VerifyJobRun
VerifyJobRun contains information specific to a verifyJobRun.
FailureCause
Well-known verify failures.
WeeklyWindow
Weekly windows. For example, blocking actions every Saturdayand Sunday. Another example would be blocking actions everyweekday from 5pm to midnight.
Modules
pagers
API documentation fordeploy_v1.services.cloud_deploy.pagers module.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.