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

Reference documentation and code samples for the SaaS Runtime V1BETA1 API class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::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, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

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

#conditions

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

#create_time

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

#dependencies

def dependencies() -> ::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitDependency>
Returns

#dependents

def dependents() -> ::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitDependency>
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.

#input_variables

def input_variables() -> ::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitVariable>
Returns

#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.

#maintenance

def maintenance() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::MaintenanceSettings
Returns

#maintenance=

def maintenance=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::MaintenanceSettings
Parameter
Returns

#management_mode

def management_mode() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::ManagementMode
Returns

#management_mode=

def management_mode=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::ManagementMode
Parameter
Returns

#name

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

    "projects/{project}/locations/{location}/units/{unit}"

#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}/units/{unit}"

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

    "projects/{project}/locations/{location}/units/{unit}"

#ongoing_operations

def ongoing_operations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

#output_variables

def output_variables() -> ::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitVariable>
Returns
  • (::Array<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::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.

#pending_operations

def pending_operations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

#release

def release() -> ::String
Returns
  • (::String) — Optional. Output only. The current Release object for this Unit.

#scheduled_operations

def scheduled_operations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Output only. List of scheduled UnitOperations for this unit.

#state

def state() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::UnitState
Returns

#system_cleanup_at

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

#system_managed_state

def system_managed_state() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit::SystemManagedState
Returns

#tenant

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

#tenant=

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

#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_kind

def unit_kind() -> ::String
Returns
  • (::String) — Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

#unit_kind=

def unit_kind=(value) -> ::String
Parameter
  • value (::String) — Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
Returns
  • (::String) — Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

#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.