Class UnitOperation (0.2.0)

Version latest

• 0.2.0 (latest)
• 0.1.0

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

UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations).

UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested.

This is a base object that contains the common fields in all unit operations. Next: 19

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Attributes
Name	Description
provision	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Provision This field is a member of oneof_ unit_operation_type.
upgrade	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Upgrade This field is a member of oneof_ unit_operation_type.
deprovision	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Deprovision This field is a member of oneof_ unit_operation_type.
name	str Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}".
unit	str Required. Immutable. The Unit a given UnitOperation will act upon.
parent_unit_operation	str Optional. Reference to parent resource: UnitOperation. If an operation needs to create other operations as part of its workflow, each of the child operations should have this field set to the parent. This can be used for tracing. (Optional)
rollout	str Optional. Specifies which rollout created this Unit Operation. This cannot be modified and is used for filtering purposes only. If a dependent unit and unit operation are created as part of another unit operation, they will use the same rolloutId.
cancel	bool Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)
state	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitOperation.UnitOperationState Optional. Output only. UnitOperationState describes the current state of the unit operation.
conditions	MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitOperationCondition] Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
schedule	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Schedule Optional. When to schedule this operation.
engine_state	str Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.
error_category	google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitOperationErrorCategory Optional. Output only. UnitOperationErrorCategory describe the error category.
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.

UnitOperationState

UnitOperationState(value)

UnitOperationState describes the current state of the unit operation.