Class Rollout (0.3.1)

Version 0.3.1

• 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	Sequence[google.cloud.deploy_v1.types.Rollout.AnnotationsEntry] 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	Sequence[google.cloud.deploy_v1.types.Rollout.LabelsEntry] Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: Each resource is limited to 64 labels. Keys must conform to the regexp: ``[a-zA-Z][a-zA-Z0-9\_-]{0,62}``. Values must conform to the regexp: ``[a-zA-Z0-9\_-]{0,63}``. Both keys and values are additionally constrained to be <= 128="" bytes="" in="" size.="">
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. Reason the build failed. Empty if the build succeeded.
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.

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.

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.