SaaS Runtime V1BETA1 API - Class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation (v0.1.0)

Reference documentation and code samples for the SaaS Runtime V1BETA1 API class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::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: 19

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#cancel

def cancel() -> ::Boolean
Returns
  • (::Boolean) — Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)

#cancel=

def cancel=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)
Returns
  • (::Boolean) — Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)

#conditions

def conditions() -> ::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperationCondition>
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#deprovision

def deprovision() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Deprovision
Returns

#deprovision=

def deprovision=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Deprovision
Parameter
Returns

#engine_state

def engine_state() -> ::String
Returns
  • (::String) — Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.

#error_category

def error_category() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperationErrorCategory
Returns

#etag

def etag() -> ::String
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name (full URI of the resource) following the standard naming scheme:

    "projects/{project}/locations/{location}/unitOperations/{unitOperation}"

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name (full URI of the resource) following the standard naming scheme:

    "projects/{project}/locations/{location}/unitOperations/{unitOperation}"

Returns
  • (::String) — Identifier. The resource name (full URI of the resource) following the standard naming scheme:

    "projects/{project}/locations/{location}/unitOperations/{unitOperation}"

#parent_unit_operation

def parent_unit_operation() -> ::String
Returns
  • (::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)

#parent_unit_operation=

def parent_unit_operation=(value) -> ::String
Parameter
  • value (::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)
Returns
  • (::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)

#provision

def provision() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Provision
Returns

#provision=

def provision=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Provision
Parameter
Returns

#rollout

def rollout() -> ::String
Returns
  • (::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.

#rollout=

def rollout=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#schedule

def schedule() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Schedule
Returns

#schedule=

def schedule=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Schedule
Parameter
Returns

#state

def state() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation::UnitOperationState
Returns

#uid

def uid() -> ::String
Returns
  • (::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.

#unit

def unit() -> ::String
Returns
  • (::String) — Required. Immutable. The Unit a given UnitOperation will act upon.

#unit=

def unit=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The Unit a given UnitOperation will act upon.
Returns
  • (::String) — Required. Immutable. The Unit a given UnitOperation will act upon.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#upgrade

def upgrade() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Upgrade
Returns

#upgrade=

def upgrade=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Upgrade
Parameter
Returns