Google Cloud Saas Platform Saas Service Mgmt V1 Client - Class Unit (0.1.0)

Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class Unit.

A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.Unit

Namespace

Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"

↳ unit_kind string

Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

↳ release string

Optional. Output only. The current Release object for this Unit.

↳ tenant string

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 string[]

Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

↳ pending_operations string[]

Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

↳ scheduled_operations string[]

Optional. Output only. List of scheduled UnitOperations for this unit.

↳ dependents array<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 array<UnitDependency>

Optional. Output only. Set of dependencies for this unit. Maximum 10.

↳ input_variables array<UnitVariable>

Optional. Output only. Indicates the current input variables deployed by the unit

↳ output_variables array<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 (in Terraform for example) and the values are fetched and returned by the actuation engine upon completion of execution.

↳ maintenance 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 int

Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).

↳ conditions array<UnitCondition>

Optional. Output only. A set of conditions which indicate the various conditions this resource can have.

↳ management_mode int

Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.

↳ system_managed_state int

Optional. Output only. Indicates the system managed state of the unit.

↳ system_cleanup_at Google\Protobuf\Timestamp

Optional. Output only. If set, indicates the time when the system will start removing the unit.

↳ application string

Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

↳ annotations array|Google\Protobuf\Internal\MapField

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 string

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 string

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

Output only. The timestamp when the resource was created.

↳ update_time Google\Protobuf\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.

↳ satisfies_pzs bool

Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.

↳ satisfies_pzi bool

Output only. Reserved for future use.

getName

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"

Returns
Type Description
string

setName

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"

Parameter
Name Description
var string
Returns
Type Description
$this

getUnitKind

Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

Returns
Type Description
string

setUnitKind

Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

Parameter
Name Description
var string
Returns
Type Description
$this

getRelease

Optional. Output only. The current Release object for this Unit.

Returns
Type Description
string

setRelease

Optional. Output only. The current Release object for this Unit.

Parameter
Name Description
var string
Returns
Type Description
$this

getTenant

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)

Returns
Type Description
string

setTenant

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)

Parameter
Name Description
var string
Returns
Type Description
$this

getOngoingOperations

Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setOngoingOperations

Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPendingOperations

Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setPendingOperations

Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getScheduledOperations

Optional. Output only. List of scheduled UnitOperations for this unit.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setScheduledOperations

Optional. Output only. List of scheduled UnitOperations for this unit.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDependents

Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.

Returns
Type Description
Google\Protobuf\RepeatedField<UnitDependency>

setDependents

Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.

Parameter
Name Description
var array<UnitDependency>
Returns
Type Description
$this

getDependencies

Optional. Output only. Set of dependencies for this unit. Maximum 10.

Returns
Type Description
Google\Protobuf\RepeatedField<UnitDependency>

setDependencies

Optional. Output only. Set of dependencies for this unit. Maximum 10.

Parameter
Name Description
var array<UnitDependency>
Returns
Type Description
$this

getInputVariables

Optional. Output only. Indicates the current input variables deployed by the unit

Returns
Type Description
Google\Protobuf\RepeatedField<UnitVariable>

setInputVariables

Optional. Output only. Indicates the current input variables deployed by the unit

Parameter
Name Description
var array<UnitVariable>
Returns
Type Description
$this

getOutputVariables

Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (in Terraform for example) and the values are fetched and returned by the actuation engine upon completion of execution.

Returns
Type Description
Google\Protobuf\RepeatedField<UnitVariable>

setOutputVariables

Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (in Terraform for example) and the values are fetched and returned by the actuation engine upon completion of execution.

Parameter
Name Description
var array<UnitVariable>
Returns
Type Description
$this

getMaintenance

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.

Returns
Type Description
Unit\MaintenanceSettings|null

hasMaintenance

clearMaintenance

setMaintenance

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.

Parameter
Name Description
var Unit\MaintenanceSettings
Returns
Type Description
$this

getState

Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).

Returns
Type Description
int Enum of type UnitState.

setState

Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).

Parameter
Name Description
var int

Enum of type UnitState.

Returns
Type Description
$this

getConditions

Optional. Output only. A set of conditions which indicate the various conditions this resource can have.

Returns
Type Description
Google\Protobuf\RepeatedField<UnitCondition>

setConditions

Optional. Output only. A set of conditions which indicate the various conditions this resource can have.

Parameter
Name Description
var array<UnitCondition>
Returns
Type Description
$this

getManagementMode

Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system.

Immutable once created.

Returns
Type Description
int Enum of type ManagementMode.

setManagementMode

Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system.

Immutable once created.

Parameter
Name Description
var int

Enum of type ManagementMode.

Returns
Type Description
$this

getSystemManagedState

Optional. Output only. Indicates the system managed state of the unit.

Returns
Type Description
int Enum of type SystemManagedState.

setSystemManagedState

Optional. Output only. Indicates the system managed state of the unit.

Parameter
Name Description
var int

Enum of type SystemManagedState.

Returns
Type Description
$this

getSystemCleanupAt

Optional. Output only. If set, indicates the time when the system will start removing the unit.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasSystemCleanupAt

clearSystemCleanupAt

setSystemCleanupAt

Optional. Output only. If set, indicates the time when the system will start removing the unit.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getApplication

Optional. Reference to the AppHub Application this unit belongs to.

All resources deployed in this Unit will be associated with the specified Application.

Returns
Type Description
string

setApplication

Optional. Reference to the AppHub Application this unit belongs to.

All resources deployed in this Unit will be associated with the specified Application.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. The labels on the resource, which can be used for categorization.

similar to Kubernetes resource labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels on the resource, which can be used for categorization.

similar to Kubernetes resource labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getUid

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.

Returns
Type Description
string

setUid

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

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.

Returns
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSatisfiesPzs

Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.

Returns
Type Description
bool

setSatisfiesPzs

Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type Description
bool

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this