Unit(mapping=None, *, ignore_unknown_fields=False, **kwargs)A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}". |
unit_kind |
str
Optional. Reference to the UnitKind this Unit belongs to. Immutable once set. |
release |
str
Optional. Output only. The current Release object for this Unit. |
tenant |
str
Optional. Reference to the Saas Tenant resource this unit belongs to. This for example informs the maintenance policies to use for scheduling future updates on a unit. (optional and immutable once created) |
ongoing_operations |
MutableSequence[str]
Optional. Output only. List of concurrent UnitOperations that are operating on this Unit. |
pending_operations |
MutableSequence[str]
Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit. |
scheduled_operations |
MutableSequence[str]
Optional. Output only. List of scheduled UnitOperations for this unit. |
dependents |
MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitDependency]
Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000. |
dependencies |
MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitDependency]
Optional. Output only. Set of dependencies for this unit. Maximum 10. |
input_variables |
MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitVariable]
Optional. Output only. Indicates the current input variables deployed by the unit |
output_variables |
MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitVariable]
Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution. |
maintenance |
google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit.MaintenanceSettings
Optional. Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future. |
state |
google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit.UnitState
Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). |
conditions |
MutableSequence[google.cloud.saasplatform_saasservicemgmt_v1beta1.types.UnitCondition]
Optional. Output only. A set of conditions which indicate the various conditions this resource can have. |
management_mode |
google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit.ManagementMode
Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created. |
system_managed_state |
google.cloud.saasplatform_saasservicemgmt_v1beta1.types.Unit.SystemManagedState
Optional. Output only. Indicates the system managed state of the unit. |
system_cleanup_at |
google.protobuf.timestamp_pb2.Timestamp
Optional. Output only. If set, indicates the time when the system will start removing the unit. |
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,
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 |
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,
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 |
MaintenanceSettings
MaintenanceSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.
ManagementMode
ManagementMode(value)ManagementMode describes who is responsible for the management of the unit.
SystemManagedState
SystemManagedState(value)UnitState
UnitState(value)UnitState annotates what is the current state of the unit itself.