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.



2861
2862
2863
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2861

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) 


2800
2801
2802
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2800

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2805
2806
2807
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2805

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


2810
2811
2812
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2810

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:



2815
2816
2817
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2815

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:



2820
2821
2822
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2820

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


2825
2826
2827
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2825

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) 


2832
2833
2834
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2832

def name
  @name
end

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

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

Returns:



2837
2838
2839
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2837

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:



2842
2843
2844
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2842

def session_status
  @session_status
end

#state ⇒ String

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

Returns:

  • (String) 


2847
2848
2849
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2847

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) 


2854
2855
2856
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2854

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) 


2859
2860
2861
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2859

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2866

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