As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Deploy v1 API¶

class google.cloud.deploy_v1.types.AbandonReleaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by AbandonRelease.

name¶

Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

Type: str

class google.cloud.deploy_v1.types.AbandonReleaseResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object for AbandonRelease.

class google.cloud.deploy_v1.types.AdvanceChildRolloutJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An advanceChildRollout Job.

class google.cloud.deploy_v1.types.AdvanceChildRolloutJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.

rollout¶

Output only. Name of the ChildRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

rollout_phase_id¶

Output only. the ID of the ChildRollout’s Phase.

Type: str

class google.cloud.deploy_v1.types.AdvanceRolloutOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains the information of an automated advance-rollout operation.

source_phase¶

Output only. The phase of a deployment that initiated the operation.

Type: str

wait¶

Output only. How long the operation will be paused.

Type: google.protobuf.duration_pb2.Duration

rollout¶

Output only. The name of the rollout that initiates the AutomationRun.

Type: str

destination_phase¶

Output only. The phase the rollout will be advanced to.

Type: str

class google.cloud.deploy_v1.types.AdvanceRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by AdvanceRollout.

name¶

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

phase_id¶

Required. The phase ID to advance the Rollout to.

Type: str

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.AdvanceRolloutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from AdvanceRollout.

class google.cloud.deploy_v1.types.AdvanceRolloutRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The AdvanceRollout automation rule will automatically advance a successful Rollout to the next phase.

id¶

Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Type: str

source_phases¶

Optional. Proceeds only after phase name matched any one in the list. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

Type: MutableSequence[str]

wait¶

Optional. How long to wait after a rollout is finished.

Type: google.protobuf.duration_pb2.Duration

condition¶

Output only. Information around the state of the Automation rule.

Type: google.cloud.deploy_v1.types.AutomationRuleCondition

class google.cloud.deploy_v1.types.AnthosCluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information specifying an Anthos Cluster.

membership¶

Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is projects/{project}/locations/{location}/memberships/{membership_name}.

Type: str

class google.cloud.deploy_v1.types.ApproveRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by ApproveRollout.

name¶

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

approved¶

Required. True = approve; false = reject

Type: bool

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ApproveRolloutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ApproveRollout.

class google.cloud.deploy_v1.types.AssociatedEntities(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information about entities associated with a Target.

gke_clusters¶

Optional. Information specifying GKE clusters as associated entities.

Type: MutableSequence[google.cloud.deploy_v1.types.GkeCluster]

anthos_clusters¶

Optional. Information specifying Anthos clusters as associated entities.

Type: MutableSequence[google.cloud.deploy_v1.types.AnthosCluster]

class google.cloud.deploy_v1.types.Automation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.

Type: str

uid¶

Output only. Unique identifier of the Automation.

Type: str

description¶

Optional. Description of the Automation. Max length is 255 characters.

Type: str

create_time¶

Output only. Time at which the automation was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time at which the automation was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

annotations¶

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints:

Annotations are key/value pairs.
Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/).
The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/).

See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.

Type: MutableMapping[str, str]

labels¶

Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 63 characters.

Type: MutableMapping[str, str]

etag¶

Optional. The weak etag of the Automation resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

suspended¶

Optional. When Suspended, automation is deactivated from execution.

Type: bool

service_account¶

Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.

Type: str

selector¶

Required. Selected resources to which the automation will be applied.

Type: google.cloud.deploy_v1.types.AutomationResourceSelector

rules¶

Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.

Type: MutableSequence[google.cloud.deploy_v1.types.AutomationRule]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.AutomationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/automation” Platform Log event that describes the Automation related events.

message¶

Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.

Type: str

automation¶

The name of the AutomationRun.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.AutomationResourceSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.

targets¶

Contains attributes about a target.

Type: MutableSequence[google.cloud.deploy_v1.types.TargetAttribute]

class google.cloud.deploy_v1.types.AutomationRolloutMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.

promote_automation_run¶

Output only. The name of the AutomationRun initiated by a promote release rule.

Type: str

advance_automation_runs¶

Output only. The names of the AutomationRuns initiated by an advance rollout rule.

Type: MutableSequence[str]

repair_automation_runs¶

Output only. The names of the AutomationRuns initiated by a repair rollout rule.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.AutomationRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

promote_release_rule¶

Optional. PromoteReleaseRule will automatically promote a release from the current target to a specified target.

This field is a member of oneof rule.

Type: google.cloud.deploy_v1.types.PromoteReleaseRule

advance_rollout_rule¶

Optional. The AdvanceRolloutRule will automatically advance a successful Rollout.

This field is a member of oneof rule.

Type: google.cloud.deploy_v1.types.AdvanceRolloutRule

repair_rollout_rule¶

Optional. The RepairRolloutRule will automatically repair a failed rollout.

This field is a member of oneof rule.

Type: google.cloud.deploy_v1.types.RepairRolloutRule

timed_promote_release_rule¶

Optional. The TimedPromoteReleaseRule will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.

This field is a member of oneof rule.

Type: google.cloud.deploy_v1.types.TimedPromoteReleaseRule

class google.cloud.deploy_v1.types.AutomationRuleCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

AutomationRuleCondition contains conditions relevant to an Automation rule.

targets_present_condition¶

Optional. Details around targets enumerated in the rule.

Type: google.cloud.deploy_v1.types.TargetsPresentCondition

timed_promote_release_condition¶

Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.

This field is a member of oneof rule_type_condition.

Type: google.cloud.deploy_v1.types.TimedPromoteReleaseCondition

class google.cloud.deploy_v1.types.AutomationRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

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.

name¶

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Type: str

create_time¶

Output only. Time at which the AutomationRun was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time at which the automationRun was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

Output only. The weak etag of the AutomationRun resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

service_account¶

Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

Type: str

automation_snapshot¶

Output only. Snapshot of the Automation taken at AutomationRun creation time.

Type: google.cloud.deploy_v1.types.Automation

target_id¶

Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.

Type: str

state¶

Output only. Current state of the AutomationRun.

Type: google.cloud.deploy_v1.types.AutomationRun.State

state_description¶

Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

Type: str

policy_violation¶

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

Type: google.cloud.deploy_v1.types.PolicyViolation

expire_time¶

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

Type: google.protobuf.timestamp_pb2.Timestamp

rule_id¶

Output only. The ID of the automation rule that initiated the operation.

Type: str

automation_id¶

Output only. The ID of the automation that initiated the operation.

Type: str

promote_release_operation¶

Output only. Promotes a release to a specified ‘Target’.

This field is a member of oneof operation.

Type: google.cloud.deploy_v1.types.PromoteReleaseOperation

advance_rollout_operation¶

Output only. Advances a rollout to the next phase.

This field is a member of oneof operation.

Type: google.cloud.deploy_v1.types.AdvanceRolloutOperation

repair_rollout_operation¶

Output only. Repairs a failed ‘Rollout’.

This field is a member of oneof operation.

Type: google.cloud.deploy_v1.types.RepairRolloutOperation

timed_promote_release_operation¶

Output only. Promotes a release to a specified ‘Target’ as defined in a Timed Promote Release rule.

This field is a member of oneof operation.

Type: google.cloud.deploy_v1.types.TimedPromoteReleaseOperation

wait_until_time¶

Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

Type: google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]¶

Bases: proto.enums.Enum

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.
ABORTED (6):: The AutomationRun was aborted.

class google.cloud.deploy_v1.types.AutomationRunEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/automation_run” Platform Log event that describes the AutomationRun related events.

message¶

Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.

Type: str

automation_run¶

The name of the AutomationRun.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

automation_id¶

Identifier of the Automation.

Type: str

rule_id¶

Identifier of the Automation rule.

Type: str

destination_target_id¶

ID of the Target to which the AutomationRun is created.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.BackoffMode(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.BuildArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Description of an a image to use during Skaffold rendering.

image¶

Image name in Skaffold configuration.

Type: str

tag¶

Image tag to use. This will generally be the full path to an image, such as “gcr.io/my-project/busybox:1.2.3” or “gcr.io/my-project/busybox@sha256:abc123”.

Type: str

class google.cloud.deploy_v1.types.Canary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Canary represents the canary deployment strategy.

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.

runtime_config¶

Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.

Type: google.cloud.deploy_v1.types.RuntimeConfig

canary_deployment¶

Configures the progressive based deployment for a Target.

This field is a member of oneof mode.

Type: google.cloud.deploy_v1.types.CanaryDeployment

custom_canary_deployment¶

Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

This field is a member of oneof mode.

Type: google.cloud.deploy_v1.types.CustomCanaryDeployment

class google.cloud.deploy_v1.types.CanaryDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CanaryDeployment represents the canary deployment configuration

percentages¶

Required. The percentage based deployments that will occur as a part of a Rollout. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.

Type: MutableSequence[int]

verify¶

Whether to run verify tests after each percentage deployment.

Type: bool

predeploy¶

Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.

Type: google.cloud.deploy_v1.types.Predeploy

postdeploy¶

Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.

Type: google.cloud.deploy_v1.types.Postdeploy

class google.cloud.deploy_v1.types.CancelAutomationRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by CancelAutomationRun.

name¶

Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Type: str

class google.cloud.deploy_v1.types.CancelAutomationRunResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from CancelAutomationRun.

class google.cloud.deploy_v1.types.CancelRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by CancelRollout.

name¶

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.CancelRolloutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from CancelRollout.

class google.cloud.deploy_v1.types.ChildRolloutJobs(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ChildRollouts job composition

create_rollout_jobs¶

Output only. List of CreateChildRolloutJobs

Type: MutableSequence[google.cloud.deploy_v1.types.Job]

advance_rollout_jobs¶

Output only. List of AdvanceChildRolloutJobs

Type: MutableSequence[google.cloud.deploy_v1.types.Job]

class google.cloud.deploy_v1.types.CloudRunConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CloudRunConfig contains the Cloud Run runtime configuration.

automatic_traffic_control¶

Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user’s behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.

Type: bool

canary_revision_tags¶

Optional. A list of tags that are added to the canary revision while the canary phase is in progress.

Type: MutableSequence[str]

prior_revision_tags¶

Optional. A list of tags that are added to the prior revision while the canary phase is in progress.

Type: MutableSequence[str]

stable_revision_tags¶

Optional. A list of tags that are added to the final stable revision when the stable phase is applied.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.CloudRunLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information specifying where to deploy a Cloud Run Service.

location¶

Required. The location for the Cloud Run Service. Format must be projects/{project}/locations/{location}.

Type: str

class google.cloud.deploy_v1.types.CloudRunMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CloudRunMetadata contains information from a Cloud Run deployment.

service¶

Output only. The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.

Type: str

service_urls¶

Output only. The Cloud Run Service urls that are associated with a Rollout.

Type: MutableSequence[str]

revision¶

Output only. The Cloud Run Revision id associated with a Rollout.

Type: str

job¶

Output only. The name of the Cloud Run job that is associated with a Rollout. Format is projects/{project}/locations/{location}/jobs/{job_name}.

Type: str

class google.cloud.deploy_v1.types.CloudRunRenderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CloudRunRenderMetadata contains Cloud Run information associated with a Release render.

service¶

Output only. The name of the Cloud Run Service in the rendered manifest. Format is projects/{project}/locations/{location}/services/{service}.

Type: str

class google.cloud.deploy_v1.types.Config(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Service-wide configuration.

name¶

Name of the configuration.

Type: str

supported_versions¶

All supported versions of Skaffold.

Type: MutableSequence[google.cloud.deploy_v1.types.SkaffoldVersion]

default_skaffold_version¶

Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.

Type: str

class google.cloud.deploy_v1.types.CreateAutomationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateAutomation.

parent¶

Required. The parent collection in which the Automation must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

automation_id¶

Required. ID of the Automation.

Type: str

automation¶

Required. The Automation to create.

Type: google.cloud.deploy_v1.types.Automation

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.CreateChildRolloutJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A createChildRollout Job.

class google.cloud.deploy_v1.types.CreateChildRolloutJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.

rollout¶

Output only. Name of the ChildRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

rollout_phase_id¶

Output only. The ID of the childRollout Phase initiated by this JobRun.

Type: str

class google.cloud.deploy_v1.types.CreateCustomTargetTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateCustomTargetType.

parent¶

Required. The parent collection in which the CustomTargetType must be created. The format is projects/{project_id}/locations/{location_name}.

Type: str

custom_target_type_id¶

Required. ID of the CustomTargetType.

Type: str

custom_target_type¶

Required. The CustomTargetType to create.

Type: google.cloud.deploy_v1.types.CustomTargetType

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.CreateDeliveryPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateDeliveryPipeline.

parent¶

Required. The parent collection in which the DeliveryPipeline must be created. The format is projects/{project_id}/locations/{location_name}.

Type: str

delivery_pipeline_id¶

Required. ID of the DeliveryPipeline.

Type: str

delivery_pipeline¶

Required. The DeliveryPipeline to create.

Type: google.cloud.deploy_v1.types.DeliveryPipeline

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.CreateDeployPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateDeployPolicy.

parent¶

Required. The parent collection in which the DeployPolicy must be created. The format is projects/{project_id}/locations/{location_name}.

Type: str

deploy_policy_id¶

Required. ID of the DeployPolicy.

Type: str

deploy_policy¶

Required. The DeployPolicy to create.

Type: google.cloud.deploy_v1.types.DeployPolicy

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.CreateReleaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateRelease,

parent¶

Required. The parent collection in which the Release is created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

release_id¶

Required. ID of the Release.

Type: str

release¶

Required. The Release to create.

Type: google.cloud.deploy_v1.types.Release

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.CreateRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CreateRolloutRequest is the request object used by CreateRollout.

parent¶

Required. The parent collection in which the Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

Type: str

rollout_id¶

Required. ID of the Rollout.

Type: str

rollout¶

Required. The Rollout to create.

Type: google.cloud.deploy_v1.types.Rollout

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

starting_phase_id¶

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

Type: str

class google.cloud.deploy_v1.types.CreateTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for CreateTarget.

parent¶

Required. The parent collection in which the Target must be created. The format is projects/{project_id}/locations/{location_name}.

Type: str

target_id¶

Required. ID of the Target.

Type: str

target¶

Required. The Target to create.

Type: google.cloud.deploy_v1.types.Target

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.CustomCanaryDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CustomCanaryDeployment represents the custom canary deployment configuration.

phase_configs¶

Required. Configuration for each phase in the canary deployment in the order executed.

Type: MutableSequence[google.cloud.deploy_v1.types.CustomCanaryDeployment.PhaseConfig]

class PhaseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

phase_id¶

Required. The ID to assign to the Rollout phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

Type: str

percentage¶

Required. Percentage deployment for the phase.

Type: int

profiles¶

Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the DeliveryPipeline stage.

Type: MutableSequence[str]

verify¶

Whether to run verify tests after the deployment.

Type: bool

predeploy¶

Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.

Type: google.cloud.deploy_v1.types.Predeploy

postdeploy¶

Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.

Type: google.cloud.deploy_v1.types.Postdeploy

class google.cloud.deploy_v1.types.CustomMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CustomMetadata contains information from a user-defined operation.

values¶

Output only. Key-value pairs provided by the user-defined operation.

Type: MutableMapping[str, str]

class ValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.CustomTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information specifying a Custom Target.

custom_target_type¶

Required. The name of the CustomTargetType. Format must be projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}.

Type: str

class google.cloud.deploy_v1.types.CustomTargetDeployMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CustomTargetDeployMetadata contains information from a Custom Target deploy operation.

skip_message¶

Output only. Skip message provided in the results of a custom deploy operation.

Type: str

class google.cloud.deploy_v1.types.CustomTargetSkaffoldActions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

CustomTargetSkaffoldActions represents the CustomTargetType configuration using Skaffold custom actions.

render_action¶

Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via skaffold render.

Type: str

deploy_action¶

Required. The Skaffold custom action responsible for deploy operations.

Type: str

include_skaffold_modules¶

Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.

Type: MutableSequence[google.cloud.deploy_v1.types.SkaffoldModules]

class google.cloud.deploy_v1.types.CustomTargetType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

Optional. Name of the CustomTargetType. Format is projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. The customTargetType component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

custom_target_type_id¶

Output only. Resource id of the CustomTargetType.

Type: str

uid¶

Output only. Unique identifier of the CustomTargetType.

Type: str

description¶

Optional. Description of the CustomTargetType. Max length is 255 characters.

Type: str

annotations¶

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Type: MutableMapping[str, str]

labels¶

Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

create_time¶

Output only. Time at which the CustomTargetType was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Most recent time at which the CustomTargetType was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

custom_actions¶

Configures render and deploy for the CustomTargetType using Skaffold custom actions.

This field is a member of oneof definition.

Type: google.cloud.deploy_v1.types.CustomTargetSkaffoldActions

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.CustomTargetTypeNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/customtargettype_notification” Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

custom_target_type_uid¶

Unique identifier of the CustomTargetType.

Type: str

custom_target_type¶

The name of the CustomTargetType.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.DefaultPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Execution using the default Cloud Build pool.

service_account¶

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.

Type: str

artifact_storage¶

Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket (“gs://my-bucket”) or a path within a bucket (“gs://my-bucket/my-dir”). If unspecified, a default bucket located in the same region will be used.

Type: str

class google.cloud.deploy_v1.types.DeleteAutomationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for DeleteAutomation.

name¶

Required. The name of the Automation to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

Type: str

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, then deleting an already deleted or non-existing Automation will succeed.

Type: bool

validate_only¶

Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.

Type: bool

etag¶

Optional. The weak etag of the request. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class google.cloud.deploy_v1.types.DeleteCustomTargetTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for DeleteCustomTargetType.

name¶

Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

Type: str

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, then deleting an already deleted or non-existing CustomTargetType will succeed.

Type: bool

validate_only¶

Optional. If set to true, the request is validated but no actual change is made.

Type: bool

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class google.cloud.deploy_v1.types.DeleteDeliveryPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for DeleteDeliveryPipeline.

name¶

Required. The name of the DeliveryPipeline to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.

Type: bool

validate_only¶

Optional. If set, validate the request and preview the review, but do not actually post it.

Type: bool

force¶

Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.

Type: bool

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class google.cloud.deploy_v1.types.DeleteDeployPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for DeleteDeployPolicy.

name¶

Required. The name of the DeployPolicy to delete. The format is projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

Type: str

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, then deleting an already deleted or non-existing DeployPolicy will succeed.

Type: bool

validate_only¶

Optional. If set, validate the request and preview the review, but do not actually post it.

Type: bool

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class google.cloud.deploy_v1.types.DeleteTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for DeleteTarget.

name¶

Required. The name of the Target to delete. The format is projects/{project_id}/locations/{location_name}/targets/{target_name}.

Type: str

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, then deleting an already deleted or non-existing Target will succeed.

Type: bool

validate_only¶

Optional. If set, validate the request and preview the review, but do not actually post it.

Type: bool

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class google.cloud.deploy_v1.types.DeliveryPipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

name¶

Optional. Name of the DeliveryPipeline. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. The deliveryPipeline component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

uid¶

Output only. Unique identifier of the DeliveryPipeline.

Type: str

description¶

Description of the DeliveryPipeline. Max length is 255 characters.

Type: str

annotations¶

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.

Type: MutableMapping[str, str]

labels¶

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

create_time¶

Output only. Time at which the pipeline was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Most recent time at which the pipeline was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

serial_pipeline¶

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

This field is a member of oneof pipeline.

Type: google.cloud.deploy_v1.types.SerialPipeline

condition¶

Output only. Information around the state of the Delivery Pipeline.

Type: google.cloud.deploy_v1.types.PipelineCondition

etag¶

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

suspended¶

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

Type: bool

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.DeliveryPipelineAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains criteria for selecting DeliveryPipelines.

id¶

ID of the DeliveryPipeline. The value of this field could be one of the following:

The last segment of a pipeline name
“*”, all delivery pipelines in a location

Type: str

labels¶

DeliveryPipeline labels.

Type: MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.DeliveryPipelineNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/deliverypipeline_notification” Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

delivery_pipeline¶

The name of the Delivery Pipeline.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.DeployArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The artifacts produced by a deploy operation.

artifact_uri¶

Output only. URI of a directory containing the artifacts. All paths are relative to this location.

Type: str

manifest_paths¶

Output only. File paths of the manifests applied during the deploy operation relative to the URI.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.DeployJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A deploy Job.

class google.cloud.deploy_v1.types.DeployJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

DeployJobRun contains information specific to a deploy JobRun.

build¶

Output only. The resource name of the Cloud Build Build object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

failure_cause¶

Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.

Type: google.cloud.deploy_v1.types.DeployJobRun.FailureCause

failure_message¶

Output only. Additional information about the deploy failure, if available.

Type: str

metadata¶

Output only. Metadata containing information about the deploy job run.

Type: google.cloud.deploy_v1.types.DeployJobRunMetadata

artifact¶

Output only. The artifact of a deploy job run, if available.

Type: google.cloud.deploy_v1.types.DeployArtifact

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

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

class google.cloud.deploy_v1.types.DeployJobRunMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.

cloud_run¶

Output only. The name of the Cloud Run Service that is associated with a DeployJobRun.

Type: google.cloud.deploy_v1.types.CloudRunMetadata

custom_target¶

Output only. Custom Target metadata associated with a DeployJobRun.

Type: google.cloud.deploy_v1.types.CustomTargetDeployMetadata

custom¶

Output only. Custom metadata provided by user-defined deploy operation.

Type: google.cloud.deploy_v1.types.CustomMetadata

class google.cloud.deploy_v1.types.DeployParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

DeployParameters contains deploy parameters information.

values¶

Required. Values are deploy parameters in key-value pairs.

Type: MutableMapping[str, str]

match_target_labels¶

Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).

Type: MutableMapping[str, str]

class MatchTargetLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.DeployPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

name¶

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

uid¶

Output only. Unique identifier of the DeployPolicy.

Type: str

description¶

Description of the DeployPolicy. Max length is 255 characters.

Type: str

annotations¶

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints:

Annotations are key/value pairs.
Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/).
The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/).

See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.

Type: MutableMapping[str, str]

labels¶

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

create_time¶

Output only. Time at which the deploy policy was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Most recent time at which the deploy policy was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

suspended¶

When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

Type: bool

selectors¶

Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action.

Type: MutableSequence[google.cloud.deploy_v1.types.DeployPolicyResourceSelector]

rules¶

Required. Rules to apply. At least one rule must be present.

Type: MutableSequence[google.cloud.deploy_v1.types.PolicyRule]

etag¶

The weak etag of the Automation resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class Invoker(value)[source]¶

Bases: proto.enums.Enum

What invoked the action. Filters enforcing the policy depending on what invoked the action.

Values:

INVOKER_UNSPECIFIED (0):: Unspecified.
USER (1):: The action is user-driven. For example, creating a rollout manually via a gcloud create command.
DEPLOY_AUTOMATION (2):: Automated action by Cloud Deploy.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.DeployPolicyEvaluationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/deploypolicy_evaluation” Platform Log event that describes the deploy policy evaluation event.

message¶

Debug message for when a deploy policy event occurs.

Type: str

rule_type¶

Rule type (e.g. Restrict Rollouts).

Type: str

rule¶

Rule id.

Type: str

pipeline_uid¶

Unique identifier of the Delivery Pipeline.

Type: str

delivery_pipeline¶

The name of the Delivery Pipeline.

Type: str

target_uid¶

Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Type: str

target¶

The name of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Type: str

invoker¶

What invoked the action (e.g. a user or automation).

Type: google.cloud.deploy_v1.types.DeployPolicy.Invoker

deploy_policy¶

The name of the DeployPolicy.

Type: str

deploy_policy_uid¶

Unique identifier of the DeployPolicy.

Type: str

allowed¶

Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn’t comply with the policy but the policy was overridden; or (3) the request doesn’t comply with the policy but the policy was suspended

Type: bool

verdict¶

The policy verdict of the request.

Type: google.cloud.deploy_v1.types.DeployPolicyEvaluationEvent.PolicyVerdict

overrides¶

Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.

Type: MutableSequence[google.cloud.deploy_v1.types.DeployPolicyEvaluationEvent.PolicyVerdictOverride]

class PolicyVerdict(value)[source]¶

Bases: proto.enums.Enum

The policy verdict of the request.

Values:

POLICY_VERDICT_UNSPECIFIED (0):: This should never happen.
ALLOWED_BY_POLICY (1):: Allowed by policy. This enum value is not currently used but may be used in the future. Currently logs are only generated when a request is denied by policy.
DENIED_BY_POLICY (2):: Denied by policy.

class PolicyVerdictOverride(value)[source]¶

Bases: proto.enums.Enum

Things that could have overridden the policy verdict. When overrides are used, the request will be allowed even if it is DENIED_BY_POLICY.

Values:

POLICY_VERDICT_OVERRIDE_UNSPECIFIED (0):: This should never happen.
POLICY_OVERRIDDEN (1):: The policy was overridden.
POLICY_SUSPENDED (2):: The policy was suspended.

class google.cloud.deploy_v1.types.DeployPolicyNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/deploypolicy_notification”. Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change.

message¶

Debug message for when a deploy policy fails to send a pub/sub notification.

Type: str

deploy_policy¶

The name of the DeployPolicy.

Type: str

deploy_policy_uid¶

Unique identifier of the deploy policy.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.DeployPolicyResourceSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains information on the resources to select for a deploy policy. Attributes provided must all match the resource in order for policy restrictions to apply. For example, if delivery pipelines attributes given are an id “prod” and labels “foo: bar”, a delivery pipeline resource must match both that id and have that label in order to be subject to the policy.

delivery_pipeline¶

Optional. Contains attributes about a delivery pipeline.

Type: google.cloud.deploy_v1.types.DeliveryPipelineAttribute

target¶

Optional. Contains attributes about a target.

Type: google.cloud.deploy_v1.types.TargetAttribute

class google.cloud.deploy_v1.types.DeploymentJobs(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Deployment job composition.

deploy_job¶

Output only. The deploy Job. This is the deploy job in the phase.

Type: google.cloud.deploy_v1.types.Job

verify_job¶

Output only. The verify Job. Runs after a deploy if the deploy succeeds.

Type: google.cloud.deploy_v1.types.Job

predeploy_job¶

Output only. The predeploy Job, which is the first job on the phase.

Type: google.cloud.deploy_v1.types.Job

postdeploy_job¶

Output only. The postdeploy Job, which is the last job on the phase.

Type: google.cloud.deploy_v1.types.Job

class google.cloud.deploy_v1.types.ExecutionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Configuration of the environment to use when calling Skaffold.

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.

usages¶

Required. Usages when this configuration should be applied.

Type: MutableSequence[google.cloud.deploy_v1.types.ExecutionConfig.ExecutionEnvironmentUsage]

default_pool¶

Optional. Use default Cloud Build pool.

This field is a member of oneof execution_environment.

Type: google.cloud.deploy_v1.types.DefaultPool

private_pool¶

Optional. Use private Cloud Build pool.

This field is a member of oneof execution_environment.

Type: google.cloud.deploy_v1.types.PrivatePool

worker_pool¶

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}. If this optional field is unspecified, the default Cloud Build pool will be used.

Type: str

service_account¶

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

Type: str

artifact_storage¶

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket (“gs://my-bucket”) or a path within a bucket (“gs://my-bucket/my-dir”). If unspecified, a default bucket located in the same region will be used.

Type: str

execution_timeout¶

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

Type: google.protobuf.duration_pb2.Duration

verbose¶

Optional. If true, additional logging will be enabled when running builds in this execution environment.

Type: bool

class ExecutionEnvironmentUsage(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.GetAutomationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetAutomation

name¶

Required. Name of the Automation. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

Type: str

class google.cloud.deploy_v1.types.GetAutomationRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetAutomationRun

name¶

Required. Name of the AutomationRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Type: str

class google.cloud.deploy_v1.types.GetConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request to get a configuration.

name¶

Required. Name of requested configuration.

Type: str

class google.cloud.deploy_v1.types.GetCustomTargetTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetCustomTargetType.

name¶

Required. Name of the CustomTargetType. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

Type: str

class google.cloud.deploy_v1.types.GetDeliveryPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetDeliveryPipeline

name¶

Required. Name of the DeliveryPipeline. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

class google.cloud.deploy_v1.types.GetDeployPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetDeployPolicy

name¶

Required. Name of the DeployPolicy. Format must be projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

Type: str

class google.cloud.deploy_v1.types.GetJobRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

GetJobRunRequest is the request object used by GetJobRun.

name¶

Required. Name of the JobRun. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.

Type: str

class google.cloud.deploy_v1.types.GetReleaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetRelease.

name¶

Required. Name of the Release. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

Type: str

class google.cloud.deploy_v1.types.GetRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

GetRolloutRequest is the request object used by GetRollout.

name¶

Required. Name of the Rollout. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.

Type: str

class google.cloud.deploy_v1.types.GetTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for GetTarget.

name¶

Required. Name of the Target. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}.

Type: str

class google.cloud.deploy_v1.types.GkeCluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information specifying a GKE Cluster.

cluster¶

Optional. Information specifying a GKE Cluster. Format is projects/{project_id}/locations/{location_id}/clusters/{cluster_id}.

Type: str

internal_ip¶

Optional. If true, cluster is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise.

Only specify this option when cluster is a private GKE cluster.

Type: bool

proxy_url¶

Optional. If set, used to configure a proxy to the Kubernetes server.

Type: str

class google.cloud.deploy_v1.types.IgnoreJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by IgnoreJob.

rollout¶

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

phase_id¶

Required. The phase ID the Job to ignore belongs to.

Type: str

job_id¶

Required. The job ID for the Job to ignore.

Type: str

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.IgnoreJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from IgnoreJob.

class google.cloud.deploy_v1.types.Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Job represents an operation for a Rollout.

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.

id¶

Output only. The ID of the Job.

Type: str

state¶

Output only. The current state of the Job.

Type: google.cloud.deploy_v1.types.Job.State

skip_message¶

Output only. Additional information on why the Job was skipped, if available.

Type: str

job_run¶

Output only. The name of the JobRun responsible for the most recent invocation of this Job.

Type: str

deploy_job¶

Output only. A deploy Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.DeployJob

verify_job¶

Output only. A verify Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.VerifyJob

predeploy_job¶

Output only. A predeploy Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.PredeployJob

postdeploy_job¶

Output only. A postdeploy Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.PostdeployJob

create_child_rollout_job¶

Output only. A createChildRollout Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.CreateChildRolloutJob

advance_child_rollout_job¶

Output only. An advanceChildRollout Job.

This field is a member of oneof job_type.

Type: google.cloud.deploy_v1.types.AdvanceChildRolloutJob

class State(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.JobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

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.

name¶

Optional. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.

Type: str

uid¶

Output only. Unique identifier of the JobRun.

Type: str

phase_id¶

Output only. ID of the Rollout phase this JobRun belongs in.

Type: str

job_id¶

Output only. ID of the Rollout job this JobRun corresponds to.

Type: str

create_time¶

Output only. Time at which the JobRun was created.

Type: google.protobuf.timestamp_pb2.Timestamp

start_time¶

Output only. Time at which the JobRun was started.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

Output only. Time at which the JobRun ended.

Type: google.protobuf.timestamp_pb2.Timestamp

state¶

Output only. The current state of the JobRun.

Type: google.cloud.deploy_v1.types.JobRun.State

deploy_job_run¶

Output only. Information specific to a deploy JobRun.

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.DeployJobRun

verify_job_run¶

Output only. Information specific to a verify JobRun.

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.VerifyJobRun

predeploy_job_run¶

Output only. Information specific to a predeploy JobRun.

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.PredeployJobRun

postdeploy_job_run¶

Output only. Information specific to a postdeploy JobRun.

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.PostdeployJobRun

create_child_rollout_job_run¶

Output only. Information specific to a createChildRollout JobRun.

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.CreateChildRolloutJobRun

advance_child_rollout_job_run¶

Output only. Information specific to an advanceChildRollout JobRun

This field is a member of oneof job_run.

Type: google.cloud.deploy_v1.types.AdvanceChildRolloutJobRun

etag¶

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

class State(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.JobRunNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/jobrun_notification” Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

job_run¶

The name of the JobRun.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

release_uid¶

Unique identifier of the Release.

Type: str

release¶

The name of the Release.

Type: str

rollout_uid¶

Unique identifier of the Rollout.

Type: str

rollout¶

The name of the Rollout.

Type: str

target_id¶

ID of the Target.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.KubernetesConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

KubernetesConfig contains the Kubernetes runtime configuration.

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.

gateway_service_mesh¶

Kubernetes Gateway API service mesh configuration.

This field is a member of oneof service_definition.

Type: google.cloud.deploy_v1.types.KubernetesConfig.GatewayServiceMesh

service_networking¶

Kubernetes Service networking configuration.

This field is a member of oneof service_definition.

Type: google.cloud.deploy_v1.types.KubernetesConfig.ServiceNetworking

class GatewayServiceMesh(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information about the Kubernetes Gateway API service mesh configuration.

http_route¶

Required. Name of the Gateway API HTTPRoute.

Type: str

service¶

Required. Name of the Kubernetes Service.

Type: str

deployment¶

Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.

Type: str

route_update_wait_time¶

Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.

Type: google.protobuf.duration_pb2.Duration

stable_cutback_duration¶

Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.

Type: google.protobuf.duration_pb2.Duration

pod_selector_label¶

Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.

Type: str

route_destinations¶

Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.

Type: google.cloud.deploy_v1.types.KubernetesConfig.GatewayServiceMesh.RouteDestinations

class RouteDestinations(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information about route destinations for the Gateway API service mesh.

destination_ids¶

Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and “@self” to include the Target cluster.

Type: MutableSequence[str]

propagate_service¶

Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.

Type: bool

class ServiceNetworking(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information about the Kubernetes Service networking configuration.

service¶

Required. Name of the Kubernetes Service.

Type: str

deployment¶

Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.

Type: str

disable_pod_overprovisioning¶

Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.

Type: bool

pod_selector_label¶

Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.

Type: str

class google.cloud.deploy_v1.types.ListAutomationRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListAutomationRuns.

parent¶

Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

Type: str

page_size¶

The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

A page token, received from a previous ListAutomationRuns call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Filter automationRuns to be returned. All fields can be used in the filter.

Type: str

order_by¶

Field to sort by.

Type: str

class google.cloud.deploy_v1.types.ListAutomationRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListAutomationRuns.

automation_runs¶

The AutomationRuns objects.

Type: MutableSequence[google.cloud.deploy_v1.types.AutomationRun]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListAutomationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListAutomations.

parent¶

Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

page_size¶

The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

A page token, received from a previous ListAutomations call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Filter automations to be returned. All fields can be used in the filter.

Type: str

order_by¶

Field to sort by.

Type: str

class google.cloud.deploy_v1.types.ListAutomationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListAutomations.

automations¶

The Automation objects.

Type: MutableSequence[google.cloud.deploy_v1.types.Automation]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListCustomTargetTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListCustomTargetTypes.

parent¶

Required. The parent that owns this collection of custom target types. Format must be projects/{project_id}/locations/{location_name}.

Type: str

page_size¶

Optional. The maximum number of CustomTargetType objects to return. The service may return fewer than this value. If unspecified, at most 50 CustomTargetType objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListCustomTargetTypes call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListCustomTargetTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListCustomTargetTypes.

custom_target_types¶

The CustomTargetType objects.

Type: MutableSequence[google.cloud.deploy_v1.types.CustomTargetType]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListDeliveryPipelinesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListDeliveryPipelines.

parent¶

Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.

Type: str

page_size¶

The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

A page token, received from a previous ListDeliveryPipelines call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Filter pipelines to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListDeliveryPipelines.

delivery_pipelines¶

The DeliveryPipeline objects.

Type: MutableSequence[google.cloud.deploy_v1.types.DeliveryPipeline]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListDeployPoliciesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListDeployPolicies.

parent¶

Required. The parent, which owns this collection of deploy policies. Format must be projects/{project_id}/locations/{location_name}.

Type: str

page_size¶

The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

A page token, received from a previous ListDeployPolicies call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.

Type: str

order_by¶

Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListDeployPoliciesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListDeployPolicies.

deploy_policies¶

The DeployPolicy objects.

Type: MutableSequence[google.cloud.deploy_v1.types.DeployPolicy]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListJobRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ListJobRunsRequest is the request object used by ListJobRuns.

parent¶

Required. The Rollout which owns this collection of JobRun objects.

Type: str

page_size¶

Optional. The maximum number of JobRun objects to return. The service may return fewer than this value. If unspecified, at most 50 JobRun objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListJobRuns call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListJobRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ListJobRunsResponse is the response object returned by ListJobRuns.

job_runs¶

The JobRun objects.

Type: MutableSequence[google.cloud.deploy_v1.types.JobRun]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListReleasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListReleases.

parent¶

Required. The DeliveryPipeline which owns this collection of Release objects.

Type: str

page_size¶

Optional. The maximum number of Release objects to return. The service may return fewer than this value. If unspecified, at most 50 Release objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListReleases call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListReleasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListReleases.

releases¶

The Release objects.

Type: MutableSequence[google.cloud.deploy_v1.types.Release]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListRolloutsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ListRolloutsRequest is the request object used by ListRollouts.

parent¶

Required. The Release which owns this collection of Rollout objects.

Type: str

page_size¶

Optional. The maximum number of Rollout objects to return. The service may return fewer than this value. If unspecified, at most 50 Rollout objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListRollouts call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListRolloutsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ListRolloutsResponse is the response object reutrned by ListRollouts.

rollouts¶

The Rollout objects.

Type: MutableSequence[google.cloud.deploy_v1.types.Rollout]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.ListTargetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for ListTargets.

parent¶

Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

Type: str

page_size¶

Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Type: int

page_token¶

Optional. A page token, received from a previous ListTargets call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.

Type: str

filter¶

Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.

Type: str

order_by¶

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Type: str

class google.cloud.deploy_v1.types.ListTargetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ListTargets.

targets¶

The Target objects.

Type: MutableSequence[google.cloud.deploy_v1.types.Target]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type: str

unreachable¶

Locations that could not be reached.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metadata includes information associated with a Rollout.

cloud_run¶

Output only. The name of the Cloud Run Service that is associated with a Rollout.

Type: google.cloud.deploy_v1.types.CloudRunMetadata

automation¶

Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.

Type: google.cloud.deploy_v1.types.AutomationRolloutMetadata

custom¶

Output only. Custom metadata provided by user-defined Rollout operations.

Type: google.cloud.deploy_v1.types.CustomMetadata

class google.cloud.deploy_v1.types.MultiTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information specifying a multiTarget.

target_ids¶

Required. The target_ids of this multiTarget.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.OneTimeWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

One-time window within which actions are restricted. For example, blocking actions over New Year’s Eve from December 31st at 5pm to January 1st at 9am.

start_date¶

Required. Start date.

Type: google.type.date_pb2.Date

start_time¶

Required. Start time (inclusive). Use 00:00 for the beginning of the day.

Type: google.type.timeofday_pb2.TimeOfDay

end_date¶

Required. End date.

Type: google.type.date_pb2.Date

end_time¶

Required. End time (exclusive). You may use 24:00 for the end of the day.

Type: google.type.timeofday_pb2.TimeOfDay

class google.cloud.deploy_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents the metadata of the long-running operation.

create_time¶

Output only. The time the operation was created.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

Output only. The time the operation finished running.

Type: google.protobuf.timestamp_pb2.Timestamp

target¶

Output only. Server-defined resource path for the target of the operation.

Type: str

verb¶

Output only. Name of the verb executed by the operation.

Type: str

status_message¶

Output only. Human-readable status of the operation, if any.

Type: str

requested_cancellation¶

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type: bool

api_version¶

Output only. API version used to start the operation.

Type: str

class google.cloud.deploy_v1.types.Phase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

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.

id¶

Output only. The ID of the Phase.

Type: str

state¶

Output only. Current state of the Phase.

Type: google.cloud.deploy_v1.types.Phase.State

skip_message¶

Output only. Additional information on why the Phase was skipped, if available.

Type: str

deployment_jobs¶

Output only. Deployment job composition.

This field is a member of oneof jobs.

Type: google.cloud.deploy_v1.types.DeploymentJobs

child_rollout_jobs¶

Output only. ChildRollout job composition.

This field is a member of oneof jobs.

Type: google.cloud.deploy_v1.types.ChildRolloutJobs

class State(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.PipelineCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

pipeline_ready_condition¶

Details around the Pipeline’s overall status.

Type: google.cloud.deploy_v1.types.PipelineReadyCondition

targets_present_condition¶

Details around targets enumerated in the pipeline.

Type: google.cloud.deploy_v1.types.TargetsPresentCondition

targets_type_condition¶

Details on the whether the targets enumerated in the pipeline are of the same type.

Type: google.cloud.deploy_v1.types.TargetsTypeCondition

class google.cloud.deploy_v1.types.PipelineReadyCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

PipelineReadyCondition contains information around the status of the Pipeline.

status¶

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

Type: bool

update_time¶

Last time the condition was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.deploy_v1.types.PolicyRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Deploy Policy rule.

rollout_restriction¶

Rollout restrictions.

This field is a member of oneof rule.

Type: google.cloud.deploy_v1.types.RolloutRestriction

class google.cloud.deploy_v1.types.PolicyViolation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why.

policy_violation_details¶

Policy violation details.

Type: MutableSequence[google.cloud.deploy_v1.types.PolicyViolationDetails]

class google.cloud.deploy_v1.types.PolicyViolationDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Policy violation details.

policy¶

Name of the policy that was violated. Policy resource will be in the format of projects/{project}/locations/{location}/policies/{policy}.

Type: str

rule_id¶

Id of the rule that triggered the policy violation.

Type: str

failure_message¶

User readable message about why the request violated a policy. This is not intended for machine parsing.

Type: str

class google.cloud.deploy_v1.types.Postdeploy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Postdeploy contains the postdeploy job configuration information.

actions¶

Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.PostdeployJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A postdeploy Job.

actions¶

Output only. The custom actions that the postdeploy Job executes.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.PostdeployJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

PostdeployJobRun contains information specific to a postdeploy JobRun.

build¶

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the postdeploy Job. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

failure_cause¶

Output only. The reason the postdeploy failed. This will always be unspecified while the postdeploy is in progress or if it succeeded.

Type: google.cloud.deploy_v1.types.PostdeployJobRun.FailureCause

failure_message¶

Output only. Additional information about the postdeploy failure, if available.

Type: str

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

Well-known postdeploy 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.
EXECUTION_FAILED (2):: The postdeploy operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED (3):: The postdeploy job run did not complete within the alloted time.
CLOUD_BUILD_REQUEST_FAILED (4):: Cloud Build failed to fulfill Cloud Deploy’s request. See failure_message for additional details.

class google.cloud.deploy_v1.types.Predeploy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Predeploy contains the predeploy job configuration information.

actions¶

Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.PredeployJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A predeploy Job.

actions¶

Output only. The custom actions that the predeploy Job executes.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.PredeployJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

PredeployJobRun contains information specific to a predeploy JobRun.

build¶

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the predeploy Job. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

failure_cause¶

Output only. The reason the predeploy failed. This will always be unspecified while the predeploy is in progress or if it succeeded.

Type: google.cloud.deploy_v1.types.PredeployJobRun.FailureCause

failure_message¶

Output only. Additional information about the predeploy failure, if available.

Type: str

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

Well-known predeploy 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.
EXECUTION_FAILED (2):: The predeploy operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED (3):: The predeploy job run did not complete within the alloted time.
CLOUD_BUILD_REQUEST_FAILED (4):: Cloud Build failed to fulfill Cloud Deploy’s request. See failure_message for additional details.

class google.cloud.deploy_v1.types.PrivatePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Execution using a private Cloud Build pool.

worker_pool¶

Required. Resource name of the Cloud Build worker pool to use. The format is projects/{project}/locations/{location}/workerPools/{pool}.

Type: str

service_account¶

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.

Type: str

artifact_storage¶

Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket (“gs://my-bucket”) or a path within a bucket (“gs://my-bucket/my-dir”). If unspecified, a default bucket located in the same region will be used.

Type: str

class google.cloud.deploy_v1.types.PromoteReleaseOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains the information of an automated promote-release operation.

target_id¶

Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.

Type: str

wait¶

Output only. How long the operation will be paused.

Type: google.protobuf.duration_pb2.Duration

rollout¶

Output only. The name of the rollout that initiates the AutomationRun.

Type: str

phase¶

Output only. The starting phase of the rollout created by this operation.

Type: str

class google.cloud.deploy_v1.types.PromoteReleaseRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The PromoteRelease rule will automatically promote a release from the current target to a specified target.

id¶

Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Type: str

wait¶

Optional. How long the release need to be paused until being promoted to the next target.

Type: google.protobuf.duration_pb2.Duration

destination_target_id¶

Optional. The ID of the stage in the pipeline to which this Release is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following:

The last segment of a target name
“@next”, the next target in the promotion sequence

Type: str

condition¶

Output only. Information around the state of the Automation rule.

Type: google.cloud.deploy_v1.types.AutomationRuleCondition

destination_phase¶

Optional. The starting phase of the rollout created by this operation. Default to the first phase.

Type: str

class google.cloud.deploy_v1.types.Release(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

name¶

Optional. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}. The release component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

uid¶

Output only. Unique identifier of the Release.

Type: str

description¶

Description of the Release. Max length is 255 characters.

Type: str

annotations¶

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Type: MutableMapping[str, str]

labels¶

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

abandoned¶

Output only. Indicates whether this is an abandoned release.

Type: bool

create_time¶

Output only. Time at which the Release was created.

Type: google.protobuf.timestamp_pb2.Timestamp

render_start_time¶

Output only. Time at which the render began.

Type: google.protobuf.timestamp_pb2.Timestamp

render_end_time¶

Output only. Time at which the render completed.

Type: google.protobuf.timestamp_pb2.Timestamp

skaffold_config_uri¶

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

Type: str

skaffold_config_path¶

Filepath of the Skaffold config inside of the config URI.

Type: str

build_artifacts¶

List of artifacts to pass through to Skaffold command.

Type: MutableSequence[google.cloud.deploy_v1.types.BuildArtifact]

delivery_pipeline_snapshot¶

Output only. Snapshot of the parent pipeline taken at release creation time.

Type: google.cloud.deploy_v1.types.DeliveryPipeline

target_snapshots¶

Output only. Snapshot of the targets taken at release creation time.

Type: MutableSequence[google.cloud.deploy_v1.types.Target]

custom_target_type_snapshots¶

Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.

Type: MutableSequence[google.cloud.deploy_v1.types.CustomTargetType]

render_state¶

Output only. Current state of the render operation.

Type: google.cloud.deploy_v1.types.Release.RenderState

etag¶

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

skaffold_version¶

The Skaffold version to use when operating on this release, such as “1.20.0”. Not all versions are valid; Cloud Deploy supports a specific set of versions.

If unset, the most recent supported Skaffold version will be used.

Type: str

target_artifacts¶

Output only. Map from target ID to the target artifacts created during the render operation.

Type: MutableMapping[str, google.cloud.deploy_v1.types.TargetArtifact]

target_renders¶

Output only. Map from target ID to details of the render operation for that target.

Type: MutableMapping[str, google.cloud.deploy_v1.types.Release.TargetRender]

condition¶

Output only. Information around the state of the Release.

Type: google.cloud.deploy_v1.types.Release.ReleaseCondition

deploy_parameters¶

Optional. The deploy parameters to use for all targets in this release.

Type: MutableMapping[str, str]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class DeployParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ReleaseCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ReleaseCondition contains all conditions relevant to a Release.

release_ready_condition¶

Details around the Releases’s overall status.

Type: google.cloud.deploy_v1.types.Release.ReleaseReadyCondition

skaffold_supported_condition¶

Details around the support state of the release’s Skaffold version.

Type: google.cloud.deploy_v1.types.Release.SkaffoldSupportedCondition

class ReleaseReadyCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

status¶

True if the Release is in a valid state. Otherwise at least one condition in ReleaseCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.

Type: bool

class RenderState(value)[source]¶

Bases: proto.enums.Enum

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.

class SkaffoldSupportedCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

SkaffoldSupportedCondition contains information about when support for the release’s version of Skaffold ends.

status¶

True if the version of Skaffold used by this release is supported.

Type: bool

skaffold_support_state¶

The Skaffold support state for this release’s version of Skaffold.

Type: google.cloud.deploy_v1.types.SkaffoldSupportState

maintenance_mode_time¶

The time at which this release’s version of Skaffold will enter maintenance mode.

Type: google.protobuf.timestamp_pb2.Timestamp

support_expiration_time¶

The time at which this release’s version of Skaffold will no longer be supported.

Type: google.protobuf.timestamp_pb2.Timestamp

class TargetArtifactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class TargetRender(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details of rendering for a single target.

rendering_build¶

Output only. The resource name of the Cloud Build Build object that is used to render the manifest for this target. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

rendering_state¶

Output only. Current state of the render operation for this Target.

Type: google.cloud.deploy_v1.types.Release.TargetRender.TargetRenderState

metadata¶

Output only. Metadata related to the Release render for this Target.

Type: google.cloud.deploy_v1.types.RenderMetadata

failure_cause¶

Output only. Reason this render failed. This will always be unspecified while the render in progress.

Type: google.cloud.deploy_v1.types.Release.TargetRender.FailureCause

failure_message¶

Output only. Additional information about the render failure, if available.

Type: str

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

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

class TargetRenderState(value)[source]¶

Bases: proto.enums.Enum

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.

class TargetRendersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.ReleaseNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/release_notification” Platform Log event that describes the failure to send release status change Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

release_uid¶

Unique identifier of the Release.

Type: str

release¶

The name of the Release.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.ReleaseRenderEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/release_render” Platform Log event that describes the render status change.

message¶

Debug message for when a render transition occurs. Provides further details as rendering progresses through render states.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

release¶

The name of the release. release_uid is not in this log message because we write some of these log messages at release creation time, before we’ve generated the uid.

Type: str

type_¶

Type of this notification, e.g. for a release render state change event.

Type: google.cloud.deploy_v1.types.Type

release_render_state¶

The state of the release render.

Type: google.cloud.deploy_v1.types.Release.RenderState

class google.cloud.deploy_v1.types.RenderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RenderMetadata includes information associated with a Release render.

cloud_run¶

Output only. Metadata associated with rendering for Cloud Run.

Type: google.cloud.deploy_v1.types.CloudRunRenderMetadata

custom¶

Output only. Custom metadata provided by user-defined render operation.

Type: google.cloud.deploy_v1.types.CustomMetadata

class google.cloud.deploy_v1.types.RepairPhase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

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.

retry¶

Output only. Records of the retry attempts for retry repair mode.

This field is a member of oneof repair_phase.

Type: google.cloud.deploy_v1.types.RetryPhase

rollback¶

Output only. Rollback attempt for rollback repair mode .

This field is a member of oneof repair_phase.

Type: google.cloud.deploy_v1.types.RollbackAttempt

class google.cloud.deploy_v1.types.RepairPhaseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Configuration of the repair phase.

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.

retry¶

Optional. Retries a failed job.

This field is a member of oneof repair_phase.

Type: google.cloud.deploy_v1.types.Retry

rollback¶

Optional. Rolls back a Rollout.

This field is a member of oneof repair_phase.

Type: google.cloud.deploy_v1.types.Rollback

class google.cloud.deploy_v1.types.RepairRolloutOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains the information for an automated repair rollout operation.

rollout¶

Output only. The name of the rollout that initiates the AutomationRun.

Type: str

current_repair_phase_index¶

Output only. The index of the current repair action in the repair sequence.

Type: int

repair_phases¶

Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.

Type: MutableSequence[google.cloud.deploy_v1.types.RepairPhase]

phase_id¶

Output only. The phase ID of the phase that includes the job being repaired.

Type: str

job_id¶

Output only. The job ID for the Job to repair.

Type: str

class google.cloud.deploy_v1.types.RepairRolloutRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The RepairRolloutRule automation rule will automatically repair a failed Rollout.

id¶

Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Type: str

phases¶

Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

Type: MutableSequence[str]

jobs¶

Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in source_phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

Type: MutableSequence[str]

condition¶

Output only. Information around the state of the ‘Automation’ rule.

Type: google.cloud.deploy_v1.types.AutomationRuleCondition

repair_phases¶

Required. Defines the types of automatic repair phases for failed jobs.

Type: MutableSequence[google.cloud.deploy_v1.types.RepairPhaseConfig]

class google.cloud.deploy_v1.types.RepairState(value)[source]¶

Bases: proto.enums.Enum

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_ABORTED (7):: The repair action was aborted.

class google.cloud.deploy_v1.types.Retry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Retries the failed job.

attempts¶

Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.

Type: int

wait¶

Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.

Type: google.protobuf.duration_pb2.Duration

backoff_mode¶

Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if wait is 0.

Type: google.cloud.deploy_v1.types.BackoffMode

class google.cloud.deploy_v1.types.RetryAttempt(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RetryAttempt represents an action of retrying the failed Cloud Deploy job.

attempt¶

Output only. The index of this retry attempt.

Type: int

wait¶

Output only. How long the operation will be paused.

Type: google.protobuf.duration_pb2.Duration

state¶

Output only. Valid state of this retry action.

Type: google.cloud.deploy_v1.types.RepairState

state_desc¶

Output only. Description of the state of the Retry.

Type: str

class google.cloud.deploy_v1.types.RetryJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RetryJobRequest is the request object used by RetryJob.

rollout¶

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

phase_id¶

Required. The phase ID the Job to retry belongs to.

Type: str

job_id¶

Required. The job ID for the Job to retry.

Type: str

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.RetryJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from ‘RetryJob’.

class google.cloud.deploy_v1.types.RetryPhase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RetryPhase contains the retry attempts and the metadata for initiating a new attempt.

total_attempts¶

Output only. The number of attempts that have been made.

Type: int

backoff_mode¶

Output only. The pattern of how the wait time of the retry attempt is calculated.

Type: google.cloud.deploy_v1.types.BackoffMode

attempts¶

Output only. Detail of a retry action.

Type: MutableSequence[google.cloud.deploy_v1.types.RetryAttempt]

class google.cloud.deploy_v1.types.Rollback(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Rolls back a Rollout.

destination_phase¶

Optional. The starting phase ID for the Rollout. If unspecified, the Rollout will start in the stable phase.

Type: str

disable_rollback_if_rollout_pending¶

Optional. If pending rollout exists on the target, the rollback operation will be aborted.

Type: bool

class google.cloud.deploy_v1.types.RollbackAttempt(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RollbackAttempt represents an action of rolling back a Cloud Deploy ‘Target’.

destination_phase¶

Output only. The phase to which the rollout will be rolled back to.

Type: str

rollout_id¶

Output only. ID of the rollback Rollout to create.

Type: str

state¶

Output only. Valid state of this rollback action.

Type: google.cloud.deploy_v1.types.RepairState

state_desc¶

Output only. Description of the state of the Rollback.

Type: str

disable_rollback_if_rollout_pending¶

Output only. If active rollout exists on the target, abort this rollback.

Type: bool

class google.cloud.deploy_v1.types.RollbackTargetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Configs for the Rollback rollout.

rollout¶

Optional. The rollback Rollout to create.

Type: google.cloud.deploy_v1.types.Rollout

starting_phase_id¶

Optional. The starting phase ID for the Rollout. If unspecified, the Rollout will start in the stable phase.

Type: str

class google.cloud.deploy_v1.types.RollbackTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for RollbackTarget.

name¶

Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Type: str

target_id¶

Required. ID of the Target that is being rolled back.

Type: str

rollout_id¶

Required. ID of the rollback Rollout to create.

Type: str

release_id¶

Optional. ID of the Release to roll back to. If this isn’t specified, the previous successful Rollout to the specified target will be used to determine the Release.

Type: str

rollout_to_roll_back¶

Optional. If provided, this must be the latest Rollout that is on the Target.

Type: str

rollback_config¶

Optional. Configs for the rollback Rollout.

Type: google.cloud.deploy_v1.types.RollbackTargetConfig

validate_only¶

Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.

Type: bool

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.RollbackTargetResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from RollbackTarget.

rollback_config¶

The config of the rollback Rollout created or will be created.

Type: google.cloud.deploy_v1.types.RollbackTargetConfig

class google.cloud.deploy_v1.types.Rollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

name¶

Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}. The rollout component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

uid¶

Output only. Unique identifier of the Rollout.

Type: str

description¶

Description of the Rollout for user purposes. Max length is 255 characters.

Type: str

annotations¶

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Type: MutableMapping[str, str]

labels¶

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

create_time¶

Output only. Time at which the Rollout was created.

Type: google.protobuf.timestamp_pb2.Timestamp

approve_time¶

Output only. Time at which the Rollout was approved.

Type: google.protobuf.timestamp_pb2.Timestamp

enqueue_time¶

Output only. Time at which the Rollout was enqueued.

Type: google.protobuf.timestamp_pb2.Timestamp

deploy_start_time¶

Output only. Time at which the Rollout started deploying.

Type: google.protobuf.timestamp_pb2.Timestamp

deploy_end_time¶

Output only. Time at which the Rollout finished deploying.

Type: google.protobuf.timestamp_pb2.Timestamp

target_id¶

Required. The ID of Target to which this Rollout is deploying.

Type: str

approval_state¶

Output only. Approval state of the Rollout.

Type: google.cloud.deploy_v1.types.Rollout.ApprovalState

state¶

Output only. Current state of the Rollout.

Type: google.cloud.deploy_v1.types.Rollout.State

failure_reason¶

Output only. Additional information about the rollout failure, if available.

Type: str

deploying_build¶

Output only. The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

etag¶

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

deploy_failure_cause¶

Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

Type: google.cloud.deploy_v1.types.Rollout.FailureCause

phases¶

Output only. The phases that represent the workflows of this Rollout.

Type: MutableSequence[google.cloud.deploy_v1.types.Phase]

metadata¶

Output only. Metadata contains information about the rollout.

Type: google.cloud.deploy_v1.types.Metadata

controller_rollout¶

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Type: str

rollback_of_rollout¶

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn’t created as a rollback.

Type: str

rolled_back_by_rollouts¶

Output only. Names of Rollouts that rolled back this Rollout.

Type: MutableSequence[str]

active_repair_automation_run¶

Output only. The AutomationRun actively repairing the rollout.

Type: str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ApprovalState(value)[source]¶

Bases: proto.enums.Enum

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.

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

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

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class State(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.RolloutNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/rollout_notification” Platform Log event that describes the failure to send rollout status change Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

pipeline_uid¶

Unique identifier of the DeliveryPipeline.

Type: str

release_uid¶

Unique identifier of the Release.

Type: str

release¶

The name of the Release.

Type: str

rollout_uid¶

Unique identifier of the Rollout.

Type: str

rollout¶

The name of the Rollout.

Type: str

target_id¶

ID of the Target that the rollout is deployed to.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.RolloutRestriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Rollout restrictions.

id¶

Required. Restriction rule ID. Required and must be unique within a DeployPolicy. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Type: str

invokers¶

Optional. What invoked the action. If left empty, all invoker types will be restricted.

Type: MutableSequence[google.cloud.deploy_v1.types.DeployPolicy.Invoker]

actions¶

Optional. Rollout actions to be restricted as part of the policy. If left empty, all actions will be restricted.

Type: MutableSequence[google.cloud.deploy_v1.types.RolloutRestriction.RolloutActions]

time_windows¶

Required. Time window within which actions are restricted.

Type: google.cloud.deploy_v1.types.TimeWindows

class RolloutActions(value)[source]¶

Bases: proto.enums.Enum

Rollout actions to be restricted as part of the policy.

Values:

ROLLOUT_ACTIONS_UNSPECIFIED (0):: Unspecified.
ADVANCE (1):: Advance the rollout to the next phase.
APPROVE (2):: Approve the rollout.
CANCEL (3):: Cancel the rollout.
CREATE (4):: Create a rollout.
IGNORE_JOB (5):: Ignore a job result on the rollout.
RETRY_JOB (6):: Retry a job for a rollout.
ROLLBACK (7):: Rollback a rollout.
TERMINATE_JOBRUN (8):: Terminate a jobrun.

class google.cloud.deploy_v1.types.RolloutUpdateEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/rollout_update” Platform Log event that describes the rollout update event.

message¶

Debug message for when a rollout update event occurs.

Type: str

pipeline_uid¶

Unique identifier of the pipeline.

Type: str

release_uid¶

Unique identifier of the release.

Type: str

release¶

The name of the Release.

Type: str

rollout¶

The name of the rollout. rollout_uid is not in this log message because we write some of these log messages at rollout creation time, before we’ve generated the uid.

Type: str

target_id¶

ID of the target.

Type: str

type_¶

Type of this notification, e.g. for a rollout update event.

Type: google.cloud.deploy_v1.types.Type

rollout_update_type¶

The type of the rollout update.

Type: google.cloud.deploy_v1.types.RolloutUpdateEvent.RolloutUpdateType

class RolloutUpdateType(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.RuntimeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

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.

kubernetes¶

Kubernetes runtime configuration.

This field is a member of oneof runtime_config.

Type: google.cloud.deploy_v1.types.KubernetesConfig

cloud_run¶

Cloud Run runtime configuration.

This field is a member of oneof runtime_config.

Type: google.cloud.deploy_v1.types.CloudRunConfig

class google.cloud.deploy_v1.types.SerialPipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

stages¶

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Type: MutableSequence[google.cloud.deploy_v1.types.Stage]

class google.cloud.deploy_v1.types.SkaffoldModules(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Skaffold Config modules and their remote source.

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.

configs¶

Optional. The Skaffold Config modules to use from the specified source.

Type: MutableSequence[str]

git¶

Remote git repository containing the Skaffold Config modules.

This field is a member of oneof source.

Type: google.cloud.deploy_v1.types.SkaffoldModules.SkaffoldGitSource

google_cloud_storage¶

Cloud Storage bucket containing the Skaffold Config modules.

This field is a member of oneof source.

Type: google.cloud.deploy_v1.types.SkaffoldModules.SkaffoldGCSSource

google_cloud_build_repo¶

Cloud Build V2 repository containing the Skaffold Config modules.

This field is a member of oneof source.

Type: google.cloud.deploy_v1.types.SkaffoldModules.SkaffoldGCBRepoSource

class SkaffoldGCBRepoSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Cloud Build V2 Repository containing Skaffold Configs.

repository¶

Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.

Type: str

path¶

Optional. Relative path from the repository root to the Skaffold Config file.

Type: str

ref¶

Optional. Branch or tag to use when cloning the repository.

Type: str

class SkaffoldGCSSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Cloud Storage bucket containing Skaffold Config modules.

source¶

Required. Cloud Storage source paths to copy recursively. For example, providing gs://my-bucket/dir/configs/* will result in Skaffold copying all files within the “dir/configs” directory in the bucket “my-bucket”.

Type: str

path¶

Optional. Relative path from the source to the Skaffold file.

Type: str

class SkaffoldGitSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Git repository containing Skaffold Config modules.

repo¶

Required. Git repository the package should be cloned from.

Type: str

path¶

Optional. Relative path from the repository root to the Skaffold file.

Type: str

ref¶

Optional. Git branch or tag to use when cloning the repository.

Type: str

class google.cloud.deploy_v1.types.SkaffoldSupportState(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.deploy_v1.types.SkaffoldVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Details of a supported Skaffold version.

version¶

Release version number. For example, “1.20.3”.

Type: str

maintenance_mode_time¶

The time at which this version of Skaffold will enter maintenance mode.

Type: google.protobuf.timestamp_pb2.Timestamp

support_expiration_time¶

The time at which this version of Skaffold will no longer be supported.

Type: google.protobuf.timestamp_pb2.Timestamp

support_end_date¶

Date when this version is expected to no longer be supported.

Type: google.type.date_pb2.Date

class google.cloud.deploy_v1.types.Stage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stage specifies a location to which to deploy.

target_id¶

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

Type: str

profiles¶

Skaffold profiles to use when rendering the manifest for this stage’s Target.

Type: MutableSequence[str]

strategy¶

Optional. The strategy to use for a Rollout to this stage.

Type: google.cloud.deploy_v1.types.Strategy

deploy_parameters¶

Optional. The deploy parameters to use for the target in this stage.

Type: MutableSequence[google.cloud.deploy_v1.types.DeployParameters]

class google.cloud.deploy_v1.types.Standard(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Standard represents the standard deployment strategy.

verify¶

Whether to verify a deployment.

Type: bool

predeploy¶

Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.

Type: google.cloud.deploy_v1.types.Predeploy

postdeploy¶

Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.

Type: google.cloud.deploy_v1.types.Postdeploy

class google.cloud.deploy_v1.types.Strategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Strategy contains deployment strategy information.

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.

standard¶

Standard deployment strategy executes a single deploy and allows verifying the deployment.

This field is a member of oneof deployment_strategy.

Type: google.cloud.deploy_v1.types.Standard

canary¶

Canary deployment strategy provides progressive percentage based deployments to a Target.

This field is a member of oneof deployment_strategy.

Type: google.cloud.deploy_v1.types.Canary

class google.cloud.deploy_v1.types.Target(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A Target resource in the Cloud Deploy API.

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

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.

name¶

Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Type: str

target_id¶

Output only. Resource id of the Target.

Type: str

uid¶

Output only. Unique identifier of the Target.

Type: str

description¶

Optional. Description of the Target. Max length is 255 characters.

Type: str

annotations¶

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Type: MutableMapping[str, str]

labels¶

Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
All characters must use UTF-8 encoding, and international characters are allowed.
Keys must start with a lowercase letter or international character.
Each resource is limited to a maximum of 64 labels.

Both keys and values are additionally constrained to be <= 128 bytes.

Type: MutableMapping[str, str]

require_approval¶

Optional. Whether or not the Target requires approval.

Type: bool

create_time¶

Output only. Time at which the Target was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Most recent time at which the Target was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

gke¶

Optional. Information specifying a GKE Cluster.

This field is a member of oneof deployment_target.

Type: google.cloud.deploy_v1.types.GkeCluster

anthos_cluster¶

Optional. Information specifying an Anthos Cluster.

This field is a member of oneof deployment_target.

Type: google.cloud.deploy_v1.types.AnthosCluster

run¶

Optional. Information specifying a Cloud Run deployment target.

This field is a member of oneof deployment_target.

Type: google.cloud.deploy_v1.types.CloudRunLocation

multi_target¶

Optional. Information specifying a multiTarget.

This field is a member of oneof deployment_target.

Type: google.cloud.deploy_v1.types.MultiTarget

custom_target¶

Optional. Information specifying a Custom Target.

This field is a member of oneof deployment_target.

Type: google.cloud.deploy_v1.types.CustomTarget

associated_entities¶

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

Type: MutableMapping[str, google.cloud.deploy_v1.types.AssociatedEntities]

etag¶

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Type: str

execution_configs¶

Configurations for all execution that relates to this Target. Each ExecutionEnvironmentUsage value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER and DEPLOY ExecutionEnvironmentUsage values. When no configurations are specified, execution will use the default specified in DefaultPool.

Type: MutableSequence[google.cloud.deploy_v1.types.ExecutionConfig]

deploy_parameters¶

Optional. The deploy parameters to use for this target.

Type: MutableMapping[str, str]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class AssociatedEntitiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class DeployParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.TargetArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The artifacts produced by a target render operation.

artifact_uri¶

Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.

This field is a member of oneof uri.

Type: str

skaffold_config_path¶

Output only. File path of the resolved Skaffold configuration relative to the URI.

Type: str

manifest_path¶

Output only. File path of the rendered manifest relative to the URI.

Type: str

phase_artifacts¶

Output only. Map from the phase ID to the phase artifacts for the Target.

Type: MutableMapping[str, google.cloud.deploy_v1.types.TargetArtifact.PhaseArtifact]

class PhaseArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains the paths to the artifacts, relative to the URI, for a phase.

skaffold_config_path¶

Output only. File path of the resolved Skaffold configuration relative to the URI.

Type: str

manifest_path¶

Output only. File path of the rendered manifest relative to the URI.

Type: str

job_manifests_path¶

Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.

Type: str

class PhaseArtifactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.TargetAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.

id¶

ID of the Target. The value of this field could be one of the following:

The last segment of a target name
“*”, all targets in a location

Type: str

labels¶

Target labels.

Type: MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.deploy_v1.types.TargetNotificationEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Payload proto for “clouddeploy.googleapis.com/target_notification” Platform Log event that describes the failure to send target status change Pub/Sub notification.

message¶

Debug message for when a notification fails to send.

Type: str

target¶

The name of the Target.

Type: str

type_¶

Type of this notification, e.g. for a Pub/Sub failure.

Type: google.cloud.deploy_v1.types.Type

class google.cloud.deploy_v1.types.TargetsPresentCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

TargetsPresentCondition contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.

status¶

True if there aren’t any missing Targets.

Type: bool

missing_targets¶

The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

Type: MutableSequence[str]

update_time¶

Last time the condition was updated.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.deploy_v1.types.TargetsTypeCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

status¶

True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.

Type: bool

error_details¶

Human readable error message.

Type: str

class google.cloud.deploy_v1.types.TerminateJobRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object used by TerminateJobRun.

name¶

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

Type: str

override_deploy_policy¶

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Type: MutableSequence[str]

class google.cloud.deploy_v1.types.TerminateJobRunResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response object from TerminateJobRun.

class google.cloud.deploy_v1.types.TimeWindows(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Time windows within which actions are restricted. See the documentation for more information on how to configure dates/times.

time_zone¶

Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).

Type: str

one_time_windows¶

Optional. One-time windows within which actions are restricted.

Type: MutableSequence[google.cloud.deploy_v1.types.OneTimeWindow]

weekly_windows¶

Optional. Recurring weekly windows within which actions are restricted.

Type: MutableSequence[google.cloud.deploy_v1.types.WeeklyWindow]

class google.cloud.deploy_v1.types.TimedPromoteReleaseCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

TimedPromoteReleaseCondition contains conditions specific to an Automation with a Timed Promote Release rule defined.

next_promotion_time¶

Output only. When the next scheduled promotion(s) will occur.

Type: google.protobuf.timestamp_pb2.Timestamp

targets_list¶

Output only. A list of targets involved in the upcoming timed promotion(s).

Type: MutableSequence[google.cloud.deploy_v1.types.TimedPromoteReleaseCondition.Targets]

class Targets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The targets involved in a single timed promotion.

source_target_id¶

Optional. The source target ID.

Type: str

destination_target_id¶

Optional. The destination target ID.

Type: str

class google.cloud.deploy_v1.types.TimedPromoteReleaseOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains the information of an automated timed promote-release operation.

target_id¶

Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.

Type: str

release¶

Output only. The name of the release to be promoted.

Type: str

phase¶

Output only. The starting phase of the rollout created by this operation.

Type: str

class google.cloud.deploy_v1.types.TimedPromoteReleaseRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The TimedPromoteReleaseRule will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.

id¶

Required. ID of the rule. This ID must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Type: str

destination_target_id¶

Optional. The ID of the stage in the pipeline to which this Release is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following:

The last segment of a target name
“@next”, the next target in the promotion sequence

Type: str

schedule¶

Required. Schedule in crontab format. e.g. “0 9 * * 1” for every Monday at 9am.

Type: str

time_zone¶

Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).

Type: str

condition¶

Output only. Information around the state of the Automation rule.

Type: google.cloud.deploy_v1.types.AutomationRuleCondition

destination_phase¶

Optional. The starting phase of the rollout created by this rule. Default to the first phase.

Type: str

class google.cloud.deploy_v1.types.Type(value)[source]¶

Bases: proto.enums.Enum

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_DEPLOY_POLICY_EVALUATION (8):: Deploy Policy evaluation.
TYPE_RENDER_STATUES_CHANGE (2):: Deprecated: This field is never used. Use release_render log type instead.

class google.cloud.deploy_v1.types.UpdateAutomationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for UpdateAutomation.

update_mask¶

Required. Field mask is used to specify the fields to be overwritten by the update in the Automation resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

Type: google.protobuf.field_mask_pb2.FieldMask

automation¶

Required. The Automation to update.

Type: google.cloud.deploy_v1.types.Automation

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, updating a Automation that does not exist will result in the creation of a new Automation.

Type: bool

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.UpdateCustomTargetTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for UpdateCustomTargetType.

update_mask¶

Required. Field mask is used to specify the fields to be overwritten by the update in the CustomTargetType resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

Type: google.protobuf.field_mask_pb2.FieldMask

custom_target_type¶

Required. The CustomTargetType to update.

Type: google.cloud.deploy_v1.types.CustomTargetType

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, updating a CustomTargetType that does not exist will result in the creation of a new CustomTargetType.

Type: bool

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.UpdateDeliveryPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for UpdateDeliveryPipeline.

update_mask¶

Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

Type: google.protobuf.field_mask_pb2.FieldMask

delivery_pipeline¶

Required. The DeliveryPipeline to update.

Type: google.cloud.deploy_v1.types.DeliveryPipeline

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.

Type: bool

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.UpdateDeployPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for UpdateDeployPolicy.

update_mask¶

Required. Field mask is used to specify the fields to be overwritten by the update in the DeployPolicy resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

Type: google.protobuf.field_mask_pb2.FieldMask

deploy_policy¶

Required. The DeployPolicy to update.

Type: google.cloud.deploy_v1.types.DeployPolicy

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, updating a DeployPolicy that does not exist will result in the creation of a new DeployPolicy.

Type: bool

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.UpdateTargetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request object for UpdateTarget.

update_mask¶

Required. Field mask is used to specify the fields to be overwritten by the update in the Target resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

Type: google.protobuf.field_mask_pb2.FieldMask

target¶

Required. The Target to update.

Type: google.cloud.deploy_v1.types.Target

request_id¶

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type: str

allow_missing¶

Optional. If set to true, updating a Target that does not exist will result in the creation of a new Target.

Type: bool

validate_only¶

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Type: bool

class google.cloud.deploy_v1.types.VerifyJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A verify Job.

class google.cloud.deploy_v1.types.VerifyJobRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

VerifyJobRun contains information specific to a verify JobRun.

build¶

Output only. The resource name of the Cloud Build Build object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.

Type: str

artifact_uri¶

Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.

Type: str

event_log_path¶

Output only. File path of the Skaffold event log relative to the artifact URI.

Type: str

failure_cause¶

Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.

Type: google.cloud.deploy_v1.types.VerifyJobRun.FailureCause

failure_message¶

Output only. Additional information about the verify failure, if available.

Type: str

class FailureCause(value)[source]¶

Bases: proto.enums.Enum

Well-known verify 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.
EXECUTION_FAILED (2):: The verify operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED (3):: The verify job run did not complete within the alloted time.
VERIFICATION_CONFIG_NOT_FOUND (4):: No Skaffold verify configuration was found.
CLOUD_BUILD_REQUEST_FAILED (5):: Cloud Build failed to fulfill Cloud Deploy’s request. See failure_message for additional details.

class google.cloud.deploy_v1.types.WeeklyWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Weekly windows. For example, blocking actions every Saturday and Sunday. Another example would be blocking actions every weekday from 5pm to midnight.

days_of_week¶

Optional. Days of week. If left empty, all days of the week will be included.

Type: MutableSequence[google.type.dayofweek_pb2.DayOfWeek]

start_time¶

Optional. Start time (inclusive). Use 00:00 for the beginning of the day. If you specify start_time you must also specify end_time. If left empty, this will block for the entire day for the days specified in days_of_week.

Type: google.type.timeofday_pb2.TimeOfDay

end_time¶

Optional. End time (exclusive). Use 24:00 to indicate midnight. If you specify end_time you must also specify start_time. If left empty, this will block for the entire day for the days specified in days_of_week.

Type: google.type.timeofday_pb2.TimeOfDay

Types for Google Cloud Deploy v1 API¶

google-cloud-deploy

Navigation

Related Topics