Package Classes (1.18.0)

Summary of entries of Classes for clouddeploy.

Classes

CloudDeployAsyncClient

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

CloudDeployClient

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

ListAutomationRunsAsyncPager

A pager for iterating through list_automation_runs requests.

This class thinly wraps an initial ListAutomationRunsResponse object, and provides an __aiter__ method to iterate through its automation_runs field.

If there are more pages, the __aiter__ method will make additional ListAutomationRuns requests and continue to iterate through the automation_runs field on the corresponding responses.

All the usual ListAutomationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAutomationRunsPager

A pager for iterating through list_automation_runs requests.

This class thinly wraps an initial ListAutomationRunsResponse object, and provides an __iter__ method to iterate through its automation_runs field.

If there are more pages, the __iter__ method will make additional ListAutomationRuns requests and continue to iterate through the automation_runs field on the corresponding responses.

All the usual ListAutomationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAutomationsAsyncPager

A pager for iterating through list_automations requests.

This class thinly wraps an initial ListAutomationsResponse object, and provides an __aiter__ method to iterate through its automations field.

If there are more pages, the __aiter__ method will make additional ListAutomations requests and continue to iterate through the automations field on the corresponding responses.

All the usual ListAutomationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAutomationsPager

A pager for iterating through list_automations requests.

This class thinly wraps an initial ListAutomationsResponse object, and provides an __iter__ method to iterate through its automations field.

If there are more pages, the __iter__ method will make additional ListAutomations requests and continue to iterate through the automations field on the corresponding responses.

All the usual ListAutomationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCustomTargetTypesAsyncPager

A pager for iterating through list_custom_target_types requests.

This class thinly wraps an initial ListCustomTargetTypesResponse object, and provides an __aiter__ method to iterate through its custom_target_types field.

If there are more pages, the __aiter__ method will make additional ListCustomTargetTypes requests and continue to iterate through the custom_target_types field on the corresponding responses.

All the usual ListCustomTargetTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCustomTargetTypesPager

A pager for iterating through list_custom_target_types requests.

This class thinly wraps an initial ListCustomTargetTypesResponse object, and provides an __iter__ method to iterate through its custom_target_types field.

If there are more pages, the __iter__ method will make additional ListCustomTargetTypes requests and continue to iterate through the custom_target_types field on the corresponding responses.

All the usual ListCustomTargetTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeliveryPipelinesAsyncPager

A pager for iterating through list_delivery_pipelines requests.

This class thinly wraps an initial ListDeliveryPipelinesResponse object, and provides an __aiter__ method to iterate through its delivery_pipelines field.

If there are more pages, the __aiter__ method will make additional ListDeliveryPipelines requests and continue to iterate through the delivery_pipelines field on the corresponding responses.

All the usual ListDeliveryPipelinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeliveryPipelinesPager

A pager for iterating through list_delivery_pipelines requests.

This class thinly wraps an initial ListDeliveryPipelinesResponse object, and provides an __iter__ method to iterate through its delivery_pipelines field.

If there are more pages, the __iter__ method will make additional ListDeliveryPipelines requests and continue to iterate through the delivery_pipelines field on the corresponding responses.

All the usual ListDeliveryPipelinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListJobRunsAsyncPager

A pager for iterating through list_job_runs requests.

This class thinly wraps an initial ListJobRunsResponse object, and provides an __aiter__ method to iterate through its job_runs field.

If there are more pages, the __aiter__ method will make additional ListJobRuns requests and continue to iterate through the job_runs field on the corresponding responses.

All the usual ListJobRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListJobRunsPager

A pager for iterating through list_job_runs requests.

This class thinly wraps an initial ListJobRunsResponse object, and provides an __iter__ method to iterate through its job_runs field.

If there are more pages, the __iter__ method will make additional ListJobRuns requests and continue to iterate through the job_runs field on the corresponding responses.

All the usual ListJobRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListReleasesAsyncPager

A pager for iterating through list_releases requests.

This class thinly wraps an initial ListReleasesResponse object, and provides an __aiter__ method to iterate through its releases field.

If there are more pages, the __aiter__ method will make additional ListReleases requests and continue to iterate through the releases field on the corresponding responses.

All the usual ListReleasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListReleasesPager

A pager for iterating through list_releases requests.

This class thinly wraps an initial ListReleasesResponse object, and provides an __iter__ method to iterate through its releases field.

If there are more pages, the __iter__ method will make additional ListReleases requests and continue to iterate through the releases field on the corresponding responses.

All the usual ListReleasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRolloutsAsyncPager

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial ListRolloutsResponse object, and provides an __aiter__ method to iterate through its rollouts field.

If there are more pages, the __aiter__ method will make additional ListRollouts requests and continue to iterate through the rollouts field on the corresponding responses.

All the usual ListRolloutsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRolloutsPager

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial ListRolloutsResponse object, and provides an __iter__ method to iterate through its rollouts field.

If there are more pages, the __iter__ method will make additional ListRollouts requests and continue to iterate through the rollouts field on the corresponding responses.

All the usual ListRolloutsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTargetsAsyncPager

A pager for iterating through list_targets requests.

This class thinly wraps an initial ListTargetsResponse object, and provides an __aiter__ method to iterate through its targets field.

If there are more pages, the __aiter__ method will make additional ListTargets requests and continue to iterate through the targets field on the corresponding responses.

All the usual ListTargetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTargetsPager

A pager for iterating through list_targets requests.

This class thinly wraps an initial ListTargetsResponse object, and provides an __iter__ method to iterate through its targets field.

If there are more pages, the __iter__ method will make additional ListTargets requests and continue to iterate through the targets field on the corresponding responses.

All the usual ListTargetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AbandonReleaseRequest

The request object used by AbandonRelease.

AbandonReleaseResponse

The response object for AbandonRelease.

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.

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 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.

This message has oneof_ 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 other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Valid state of an AutomationRun.

Values: STATE_UNSPECIFIED (0): The AutomationRun has an unspecified state. SUCCEEDED (1): The AutomationRun has succeeded. CANCELLED (2): The AutomationRun was cancelled. FAILED (3): The AutomationRun has failed. IN_PROGRESS (4): The AutomationRun is in progress. PENDING (5): The AutomationRun is pending.

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.

Values: BACKOFF_MODE_UNSPECIFIED (0): No WaitMode is specified. BACKOFF_MODE_LINEAR (1): Increases the wait time linearly. BACKOFF_MODE_EXPONENTIAL (2): Increases the wait time exponentially.

BuildArtifact

Description of an a image to use during Skaffold rendering.

Canary

Canary represents the canary deployment strategy.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

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.

Config

Service-wide configuration.

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.

PhaseConfig

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

CustomMetadata

CustomMetadata contains information from a user-defined operation.

ValuesEntry

The abstract base class for a message.

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.

.. _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.

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.

.. _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.

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.

FailureCause

Well-known deploy failures.

Values: FAILURE_CAUSE_UNSPECIFIED (0): No reason for failure is specified. CLOUD_BUILD_UNAVAILABLE (1): Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See Required permission <https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions>__. EXECUTION_FAILED (2): The deploy operation did not complete successfully; check Cloud Build logs. DEADLINE_EXCEEDED (3): The deploy job run did not complete within the alloted time. MISSING_RESOURCES_FOR_CANARY (4): There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information. CLOUD_BUILD_REQUEST_FAILED (5): Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details. DEPLOY_FEATURE_NOT_SUPPORTED (6): The deploy operation had a feature configured that is not supported.

DeployJobRunMetadata

DeployJobRunMetadata surfaces information associated with a DeployJobRun 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.

DeploymentJobs

Deployment job composition.

ExecutionConfig

Configuration of the environment to use when calling Skaffold.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionEnvironmentUsage

Possible usages of this configuration.

Values: EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED (0): Default value. This value is unused. RENDER (1): Use for rendering. DEPLOY (2): Use for deploying and deployment hooks. VERIFY (3): Use for deployment verification. PREDEPLOY (4): Use for predeploy job execution. POSTDEPLOY (5): Use for postdeploy job execution.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Valid states of a Job.

Values: STATE_UNSPECIFIED (0): The Job has an unspecified state. PENDING (1): The Job is waiting for an earlier Phase(s) or Job(s) to complete. DISABLED (2): The Job is disabled. IN_PROGRESS (3): The Job is in progress. SUCCEEDED (4): The Job succeeded. FAILED (5): The Job failed. ABORTED (6): The Job was aborted. SKIPPED (7): The Job was skipped. IGNORED (8): The Job was ignored.

JobRun

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Valid states of a JobRun.

Values: STATE_UNSPECIFIED (0): The JobRun has an unspecified state. IN_PROGRESS (1): The JobRun is in progress. SUCCEEDED (2): The JobRun has succeeded. FAILED (3): The JobRun has failed. TERMINATING (4): The JobRun is terminating. TERMINATED (5): The JobRun was terminated.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GatewayServiceMesh

Information about the Kubernetes Gateway API service mesh configuration.

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.

Metadata

Metadata includes information associated with a Rollout.

MultiTarget

Information specifying a multiTarget.

OperationMetadata

Represents the metadata of the long-running operation.

Phase

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Valid states of a Phase.

Values: STATE_UNSPECIFIED (0): The Phase has an unspecified state. PENDING (1): The Phase is waiting for an earlier Phase(s) to complete. IN_PROGRESS (2): The Phase is in progress. SUCCEEDED (3): The Phase has succeeded. FAILED (4): The Phase has failed. ABORTED (5): The Phase was aborted. SKIPPED (6): The Phase was skipped.

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.

FailureCause

Well-known postdeploy failures.

Predeploy

Predeploy contains the predeploy job configuration information.

PredeployJob

A predeploy Job.

PredeployJobRun

PredeployJobRun contains information specific to a predeploy JobRun.

FailureCause

Well-known predeploy failures.

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.

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 a 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.

RenderState

Valid states of the render operation.

Values: RENDER_STATE_UNSPECIFIED (0): The render state is unspecified. SUCCEEDED (1): All rendering operations have completed successfully. FAILED (2): All rendering operations have completed, and one or more have failed. IN_PROGRESS (3): Rendering has started and is not complete.

SkaffoldSupportedCondition

SkaffoldSupportedCondition contains information about when support 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.

Values: FAILURE_CAUSE_UNSPECIFIED (0): No reason for failure is specified. CLOUD_BUILD_UNAVAILABLE (1): Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission <https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions>__. EXECUTION_FAILED (2): The render operation did not complete successfully; check Cloud Build logs. CLOUD_BUILD_REQUEST_FAILED (3): Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details. VERIFICATION_CONFIG_NOT_FOUND (4): The render operation did not complete successfully because the verification stanza required for verify was not found on the Skaffold configuration. CUSTOM_ACTION_NOT_FOUND (5): The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the Skaffold configuration. See failure_message for additional details. DEPLOYMENT_STRATEGY_NOT_SUPPORTED (6): Release failed during rendering because the release configuration is not supported with the specified deployment strategy. RENDER_FEATURE_NOT_SUPPORTED (7): The render operation had a feature configured that is not supported.

TargetRenderState

Valid states of the render operation.

Values: TARGET_RENDER_STATE_UNSPECIFIED (0): The render operation state is unspecified. SUCCEEDED (1): The render operation has completed successfully. FAILED (2): The render operation has failed. IN_PROGRESS (3): The render operation is in progress.

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 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RepairPhase

RepairPhase tracks the repair attempts that have been made for each RepairMode specified in the Automation resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RepairRolloutOperation

Contains the information for an automated repair rollout operation.

RepairRolloutRule

The RepairRolloutRule automation rule will automatically repair a failed Rollout.

RepairState

Valid state of a repair attempt.

Values: REPAIR_STATE_UNSPECIFIED (0): The repair has an unspecified state. REPAIR_STATE_SUCCEEDED (1): The repair action has succeeded. REPAIR_STATE_CANCELLED (2): The repair action was cancelled. REPAIR_STATE_FAILED (3): The repair action has failed. REPAIR_STATE_IN_PROGRESS (4): The repair action is in progress. REPAIR_STATE_PENDING (5): The repair action is pending. REPAIR_STATE_SKIPPED (6): The repair action was skipped.

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.

AnnotationsEntry

The abstract base class for a message.

ApprovalState

Valid approval states of a Rollout.

Values: APPROVAL_STATE_UNSPECIFIED (0): The Rollout has an unspecified approval state. NEEDS_APPROVAL (1): The Rollout requires approval. DOES_NOT_NEED_APPROVAL (2): The Rollout does not require approval. APPROVED (3): The Rollout has been approved. REJECTED (4): The Rollout has been rejected.

FailureCause

Well-known rollout failures.

Values: FAILURE_CAUSE_UNSPECIFIED (0): No reason for failure is specified. CLOUD_BUILD_UNAVAILABLE (1): Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission <https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions>__. EXECUTION_FAILED (2): The deploy operation did not complete successfully; check Cloud Build logs. DEADLINE_EXCEEDED (3): Deployment did not complete within the alloted time. RELEASE_FAILED (4): Release is in a failed state. RELEASE_ABANDONED (5): Release is abandoned. VERIFICATION_CONFIG_NOT_FOUND (6): No Skaffold verify configuration was found. CLOUD_BUILD_REQUEST_FAILED (7): Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details. OPERATION_FEATURE_NOT_SUPPORTED (8): A Rollout operation had a feature configured that is not supported.

LabelsEntry

The abstract base class for a message.

State

Valid states of a Rollout.

Values: STATE_UNSPECIFIED (0): The Rollout has an unspecified state. SUCCEEDED (1): The Rollout has completed successfully. FAILED (2): The Rollout has failed. IN_PROGRESS (3): The Rollout is being deployed. PENDING_APPROVAL (4): The Rollout needs approval. APPROVAL_REJECTED (5): An approver rejected the Rollout. PENDING (6): The Rollout is waiting for an earlier Rollout(s) to complete on this Target. PENDING_RELEASE (7): The Rollout is waiting for the Release to be fully rendered. CANCELLING (8): The Rollout is in the process of being cancelled. CANCELLED (9): The Rollout has been cancelled. HALTED (10): The Rollout is halted.

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.

RolloutUpdateType

RolloutUpdateType indicates the type of the rollout update.

Values: ROLLOUT_UPDATE_TYPE_UNSPECIFIED (0): Rollout update type unspecified. PENDING (1): rollout state updated to pending. PENDING_RELEASE (2): Rollout state updated to pending release. IN_PROGRESS (3): Rollout state updated to in progress. CANCELLING (4): Rollout state updated to cancelling. CANCELLED (5): Rollout state updated to cancelled. HALTED (6): Rollout state updated to halted. SUCCEEDED (7): Rollout state updated to succeeded. FAILED (8): Rollout state updated to failed. APPROVAL_REQUIRED (9): Rollout requires approval. APPROVED (10): Rollout has been approved. REJECTED (11): Rollout has been rejected. ADVANCE_REQUIRED (12): Rollout requires advance to the next phase. ADVANCED (13): Rollout has been advanced.

RuntimeConfig

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SerialPipeline

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

SkaffoldModules

Skaffold Config modules and their remote source.

.. _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.

Values: SKAFFOLD_SUPPORT_STATE_UNSPECIFIED (0): Default value. This value is unused. SKAFFOLD_SUPPORT_STATE_SUPPORTED (1): This Skaffold version is currently supported. SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE (2): This Skaffold version is in maintenance mode. SKAFFOLD_SUPPORT_STATE_UNSUPPORTED (3): This Skaffold version is no longer supported.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Target

A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnnotationsEntry

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, for a phase.

PhaseArtifactsEntry

The abstract base class for a message.

TargetAttribute

Contains criteria for selecting Targets.

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 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.

Type

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

Values: TYPE_UNSPECIFIED (0): Type is unspecified. TYPE_PUBSUB_NOTIFICATION_FAILURE (1): A Pub/Sub notification failed to be sent. TYPE_RESOURCE_STATE_CHANGE (3): Resource state changed. TYPE_PROCESS_ABORTED (4): A process aborted. TYPE_RESTRICTION_VIOLATED (5): Restriction check failed. TYPE_RESOURCE_DELETED (6): Resource deleted. TYPE_ROLLOUT_UPDATE (7): Rollout updated. TYPE_RENDER_STATUES_CHANGE (2): Deprecated: This field is never used. Use release_render log type instead.

Modules

pagers

API documentation for deploy_v1.services.cloud_deploy.pagers module.