Class Rollout (1.4.0)

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	`Mapping[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	`Mapping[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	`Sequence[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.

Inheritance

builtins.object > proto.message.Message > Rollout

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.

FailureCause

FailureCause(value)

Well-known rollout failures.

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.