Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

Environment represents a user-visible compute infrastructure for analytics within a lake.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Environment

Returns a new instance of GoogleCloudDataplexV1Environment.



4441
4442
4443
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4441

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Environment creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


4380
4381
4382
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4380

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the environment. Corresponds to the JSON property description

Returns:

  • (String) 


4385
4386
4387
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4385

def description
  @description
end

#display_name ⇒ String

Optional. User friendly display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


4390
4391
4392
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4390

def display_name
  @display_name
end

#endpoints ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EnvironmentEndpoints

URI Endpoints to access sessions associated with the Environment. Corresponds to the JSON property endpoints

Returns:



4395
4396
4397
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4395

def endpoints
  @endpoints
end

#infrastructure_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EnvironmentInfrastructureSpec

Configuration for the underlying infrastructure used to run workloads. Corresponds to the JSON property infrastructureSpec

Returns:



4400
4401
4402
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4400

def infrastructure_spec
  @infrastructure_spec
end

#labels ⇒ Hash<String,String>

Optional. User defined labels for the environment. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4405
4406
4407
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4405

def labels
  @labels
end

#name ⇒ 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 Corresponds to the JSON property name

Returns:

  • (String) 


4412
4413
4414
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4412

def name
  @name
end

#session_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EnvironmentSessionSpec

Configuration for sessions created for this environment. Corresponds to the JSON property sessionSpec

Returns:



4417
4418
4419
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4417

def session_spec
  @session_spec
end

#session_status ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1EnvironmentSessionStatus

Status of sessions created for this environment. Corresponds to the JSON property sessionStatus

Returns:



4422
4423
4424
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4422

def session_status
  @session_status
end

#state ⇒ String

Output only. Current state of the environment. Corresponds to the JSON property state

Returns:

  • (String) 


4427
4428
4429
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4427

def state
  @state
end

#uid ⇒ 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. Corresponds to the JSON property uid

Returns:

  • (String) 


4434
4435
4436
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4434

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the environment was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4439
4440
4441
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4439

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4446

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @endpoints = args[:endpoints] if args.key?(:endpoints)
  @infrastructure_spec = args[:infrastructure_spec] if args.key?(:infrastructure_spec)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @session_spec = args[:session_spec] if args.key?(:session_spec)
  @session_status = args[:session_status] if args.key?(:session_status)
  @state = args[:state] if args.key?(:state)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end