Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Environment.
Environment represents a user-visible compute infrastructure for analytics within a lake.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Environment creation time.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the environment.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the environment.
Returns
- (::String) — Optional. Description of the environment.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. User friendly display name.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. User friendly display name.
Returns
- (::String) — Optional. User friendly display name.
#endpoints
def endpoints() -> ::Google::Cloud::Dataplex::V1::Environment::Endpoints
Returns
- (::Google::Cloud::Dataplex::V1::Environment::Endpoints) — Output only. URI Endpoints to access sessions associated with the Environment.
#infrastructure_spec
def infrastructure_spec() -> ::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec
Returns
- (::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec) — Required. Infrastructure specification for the Environment.
#infrastructure_spec=
def infrastructure_spec=(value) -> ::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec
Parameter
- value (::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec) — Required. Infrastructure specification for the Environment.
Returns
- (::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec) — Required. Infrastructure specification for the Environment.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the environment.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the environment.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User defined labels for the environment.
#name
def name() -> ::String
Returns
- (::String) — Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
#session_spec
def session_spec() -> ::Google::Cloud::Dataplex::V1::Environment::SessionSpec
Returns
- (::Google::Cloud::Dataplex::V1::Environment::SessionSpec) — Optional. Configuration for sessions created for this environment.
#session_spec=
def session_spec=(value) -> ::Google::Cloud::Dataplex::V1::Environment::SessionSpec
Parameter
- value (::Google::Cloud::Dataplex::V1::Environment::SessionSpec) — Optional. Configuration for sessions created for this environment.
Returns
- (::Google::Cloud::Dataplex::V1::Environment::SessionSpec) — Optional. Configuration for sessions created for this environment.
#session_status
def session_status() -> ::Google::Cloud::Dataplex::V1::Environment::SessionStatus
Returns
- (::Google::Cloud::Dataplex::V1::Environment::SessionStatus) — Output only. Status of sessions created for this environment.
#state
def state() -> ::Google::Cloud::Dataplex::V1::State
Returns
- (::Google::Cloud::Dataplex::V1::State) — Output only. Current state of the environment.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the environment was last updated.