Class RolloutKind (0.2.0)

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

An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}".
unit_kind str
Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
rollout_orchestration_strategy str
Optional. The strategy used for executing a Rollout. This is a required field. 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 associated 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.
update_unit_kind_strategy google.cloud.saasplatform_saasservicemgmt_v1beta1.types.RolloutKind.UpdateUnitKindStrategy
Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
error_budget google.cloud.saasplatform_saasservicemgmt_v1beta1.types.ErrorBudget
Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio \* total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered. This field is a member of oneof_ _error_budget.
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.

UpdateUnitKindStrategy

UpdateUnitKindStrategy(value)