Class Rollout (1.10.0)

Version 1.10.0

• 2.4.1 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.19.1
• 1.18.1
• 1.17.3
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.0
• 0.3.2
• 0.2.0
• 0.1.1

Rollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Rollout resource in the Google Cloud Deploy API.

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

Attributes
Name	Description
name	str Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z][a-z0-9-]{0,62}.
uid	str Output only. Unique identifier of the Rollout.
description	str Description of the Rollout for user purposes. Max length is 255 characters.
annotations	MutableMapping[str, str] User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
labels	MutableMapping[str, str] Labels are attributes that can be set and used by both the user and by Google 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.="">
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the Rollout was created.
approve_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the Rollout was approved.
enqueue_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the Rollout was enqueued.
deploy_start_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the Rollout started deploying.
deploy_end_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the Rollout finished deploying.
target_id	str Required. The ID of Target to which this Rollout is deploying.
approval_state	google.cloud.deploy_v1.types.Rollout.ApprovalState Output only. Approval state of the Rollout.
state	google.cloud.deploy_v1.types.Rollout.State Output only. Current state of the Rollout.
failure_reason	str Output only. Additional information about the rollout failure, if available.
deploying_build	str 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}.
etag	str 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.
deploy_failure_cause	google.cloud.deploy_v1.types.Rollout.FailureCause Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
phases	MutableSequence[google.cloud.deploy_v1.types.Phase] Output only. The phases that represent the workflows of this Rollout.
metadata	google.cloud.deploy_v1.types.Metadata Output only. Metadata contains information about the rollout.
controller_rollout	str Output only. Name of the ControllerRollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z][a-z0-9-]{0,62}.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ApprovalState

ApprovalState(value)

Valid approval states of a Rollout.

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

FailureCause

FailureCause(value)

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 </deploy/docs/cloud-deploy-service-account#required_permissions>__. EXECUTION_FAILED (2): The deploy operation did not complete successfully; check Cloud Build logs. DEADLINE_EXCEEDED (3): Deployment did not complete within the alloted time. RELEASE_FAILED (4): Release is in a failed state. RELEASE_ABANDONED (5): Release is abandoned. VERIFICATION_CONFIG_NOT_FOUND (6): No skaffold verify configuration was found. CLOUD_BUILD_REQUEST_FAILED (7): Cloud Build failed to fulfill Google Cloud Deploy's request. See failure_message for additional details.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

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.