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.



1461
1462
1463
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1461

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) 


1400
1401
1402
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1400

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1405
1406
1407
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1405

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


1410
1411
1412
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1410

def display_name
  @display_name
end

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

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

Returns:



1415
1416
1417
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1415

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:



1420
1421
1422
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1420

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>) 


1425
1426
1427
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1425

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) 


1432
1433
1434
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1432

def name
  @name
end

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

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

Returns:



1437
1438
1439
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1437

def session_spec
  @session_spec
end

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

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

Returns:



1442
1443
1444
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1442

def session_status
  @session_status
end

#state ⇒ String

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

Returns:

  • (String) 


1447
1448
1449
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1447

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) 


1454
1455
1456
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1454

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) 


1459
1460
1461
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1459

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1466

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