Class Rollout (0.4.0) 

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

Represents a single rollout execution and its results

Attributes
Name Description
name str
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}".
release str
Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
start_time google.protobuf.timestamp_pb2.Timestamp
Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
end_time google.protobuf.timestamp_pb2.Timestamp
Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
state google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Rollout.RolloutState
Output only. Current state of the rollout.
state_message str
Output only. Human readable message indicating details about the last state transition.
state_transition_time google.protobuf.timestamp_pb2.Timestamp
Optional. Output only. The time when the rollout transitioned into its current state.
root_rollout str
Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}".
parent_rollout str
Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}".
rollout_orchestration_strategy str
Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
unit_filter str
Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.
rollout_kind str
Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
stats google.cloud.saasplatform_saasservicemgmt_v1beta1.types.RolloutStats
Optional. Output only. Details about the progress of the rollout.
control google.cloud.saasplatform_saasservicemgmt_v1beta1.types.RolloutControl
Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
labels MutableMapping[str, str]
Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
annotations MutableMapping[str, str]
Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
uid str
Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
etag str
Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when the resource was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

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.

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.

RolloutState

RolloutState(value)

The current state of the rollout.