Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class UnitOperation.
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: 22
Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.UnitOperation
Namespace
Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ provision |
Provision
Optional. Provision operation. |
↳ upgrade |
Upgrade
Optional. Upgrade operation. |
↳ deprovision |
Deprovision
Optional. Deprovision operation. |
↳ name |
string
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}" |
↳ unit |
string
Required. Immutable. The Unit a given UnitOperation will act upon. |
↳ parent_unit_operation |
string
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 |
string
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 |
int
Optional. Output only. UnitOperationState describes the current state of the unit operation. |
↳ conditions |
array<UnitOperationCondition>
Optional. Output only. A set of conditions which indicate the various conditions this resource can have. |
↳ schedule |
Schedule
Optional. When to schedule this operation. |
↳ engine_state |
string
Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. |
↳ error_category |
int
Optional. Output only. UnitOperationErrorCategory describe the error category. |
↳ duration_limits |
DurationLimits
Optional. Defines the duration limits for this specific UnitOperation instance. These settings override any default duration limits set on the UnitKind. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout. |
↳ 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. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation). |
getProvision
Optional. Provision operation.
| Returns | |
|---|---|
| Type | Description |
Provision|null |
|
hasProvision
setProvision
Optional. Provision operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Provision
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpgrade
Optional. Upgrade operation.
| Returns | |
|---|---|
| Type | Description |
Upgrade|null |
|
hasUpgrade
setUpgrade
Optional. Upgrade operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Upgrade
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeprovision
Optional. Deprovision operation.
| Returns | |
|---|---|
| Type | Description |
Deprovision|null |
|
hasDeprovision
setDeprovision
Optional. Deprovision operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Deprovision
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnit
Required. Immutable. The Unit a given UnitOperation will act upon.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUnit
Required. Immutable. The Unit a given UnitOperation will act upon.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentUnitOperation
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)
| Returns | |
|---|---|
| Type | Description |
string |
|
setParentUnitOperation
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)
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRollout
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRollout
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCancel
Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)
| Returns | |
|---|---|
| Type | Description |
bool |
|
setCancel
Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Optional. Output only. UnitOperationState describes the current state of the unit operation.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type UnitOperationState. |
setState
Optional. Output only. UnitOperationState describes the current state of the unit operation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type UnitOperationState. |
| 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<UnitOperationCondition> |
|
setConditions
Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
| Parameter | |
|---|---|
| Name | Description |
var |
array<UnitOperationCondition>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchedule
Optional. When to schedule this operation.
| Returns | |
|---|---|
| Type | Description |
Schedule|null |
|
hasSchedule
clearSchedule
setSchedule
Optional. When to schedule this operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Schedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineState
Optional. Output only. The engine state for on-going deployment engine operation(s).
This field is opaque for external usage.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEngineState
Optional. Output only. The engine state for on-going deployment engine operation(s).
This field is opaque for external usage.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorCategory
Optional. Output only. UnitOperationErrorCategory describe the error category.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type UnitOperationErrorCategory. |
setErrorCategory
Optional. Output only. UnitOperationErrorCategory describe the error category.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type UnitOperationErrorCategory. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDurationLimits
Optional. Defines the duration limits for this specific UnitOperation instance.
These settings override any default duration limits set on the UnitKind. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout.
| Returns | |
|---|---|
| Type | Description |
DurationLimits|null |
|
hasDurationLimits
clearDurationLimits
setDurationLimits
Optional. Defines the duration limits for this specific UnitOperation instance.
These settings override any default duration limits set on the UnitKind. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout.
| Parameter | |
|---|---|
| Name | Description |
var |
DurationLimits
|
| 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 |
|
getDeleteTime
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitOperationType
| Returns | |
|---|---|
| Type | Description |
string |
|