Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::Environment (v1.0.1)

Reference documentation and code samples for the Cloud Composer V1 API class Google::Cloud::Orchestration::Airflow::Service::V1::Environment.

An environment for running orchestration tasks.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#config

def config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig
Returns

#config=

def config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig
Parameter
Returns

#create_time

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

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

    • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
    • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
    • Both keys and values are additionally constrained to be <= 128 bytes in size.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

    • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
    • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
    • Both keys and values are additionally constrained to be <= 128 bytes in size.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

    • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
    • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
    • Both keys and values are additionally constrained to be <= 128 bytes in size.

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

    EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

    EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Returns
  • (::String) — The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

    EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#state

def state() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::Environment::State
Returns

#state=

def state=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::Environment::State
Parameter
Returns

#storage_config

def storage_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::StorageConfig
Returns

#storage_config=

def storage_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::StorageConfig
Parameter
Returns

#update_time

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

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#uuid

def uuid() -> ::String
Returns
  • (::String) — Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

#uuid=

def uuid=(value) -> ::String
Parameter
  • value (::String) — Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.
Returns
  • (::String) — Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.