Class: Google::Apis::DataprocV1::Session

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

Overview

A representation of a session.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Session

Returns a new instance of Session.



4741
4742
4743
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4741

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time when the session was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4658
4659
4660
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4658

def create_time
  @create_time
end

#creator ⇒ String

Output only. The email address of the user who created the session. Corresponds to the JSON property creator

Returns:

  • (String) 


4663
4664
4665
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4663

def creator
  @creator
end

#environment_config ⇒ Google::Apis::DataprocV1::EnvironmentConfig

Environment configuration for a workload. Corresponds to the JSON property environmentConfig

Returns:



4668
4669
4670
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4668

def environment_config
  @environment_config
end

#jupyter_session ⇒ Google::Apis::DataprocV1::JupyterConfig

Jupyter configuration for an interactive session. Corresponds to the JSON property jupyterSession

Returns:



4673
4674
4675
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4673

def jupyter_session
  @jupyter_session
end

#labels ⇒ Hash<String,String>

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/ rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) . No more than 32 labels can be associated with a session. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4682
4683
4684
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4682

def labels
  @labels
end

#name ⇒ String

Required. The resource name of the session. Corresponds to the JSON property name

Returns:

  • (String) 


4687
4688
4689
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4687

def name
  @name
end

#runtime_config ⇒ Google::Apis::DataprocV1::RuntimeConfig

Runtime configuration for a workload. Corresponds to the JSON property runtimeConfig

Returns:



4692
4693
4694
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4692

def runtime_config
  @runtime_config
end

#runtime_info ⇒ Google::Apis::DataprocV1::RuntimeInfo

Runtime information about workload execution. Corresponds to the JSON property runtimeInfo

Returns:



4697
4698
4699
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4697

def runtime_info
  @runtime_info
end

#session_template ⇒ String

Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis. com/compute/v1/projects/[project_id]/locations/[dataproc_region]/ sessionTemplates/[template_id] * projects/[project_id]/locations/[ dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. Corresponds to the JSON property sessionTemplate

Returns:

  • (String) 


4707
4708
4709
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4707

def session_template
  @session_template
end

#state ⇒ String

Output only. A state of the session. Corresponds to the JSON property state

Returns:

  • (String) 


4712
4713
4714
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4712

def state
  @state
end

#state_history ⇒ Array<Google::Apis::DataprocV1::SessionStateHistory>

Output only. Historical state information for the session. Corresponds to the JSON property stateHistory

Returns:



4717
4718
4719
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4717

def state_history
  @state_history
end

#state_message ⇒ String

Output only. Session state details, such as the failure description if the state is FAILED. Corresponds to the JSON property stateMessage

Returns:

  • (String) 


4723
4724
4725
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4723

def state_message
  @state_message
end

#state_time ⇒ String

Output only. The time when the session entered the current state. Corresponds to the JSON property stateTime

Returns:

  • (String) 


4728
4729
4730
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4728

def state_time
  @state_time
end

#user ⇒ String

Optional. The email address of the user who owns the session. Corresponds to the JSON property user

Returns:

  • (String) 


4733
4734
4735
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4733

def user
  @user
end

#uuid ⇒ String

Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. Corresponds to the JSON property uuid

Returns:

  • (String) 


4739
4740
4741
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4739

def uuid
  @uuid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4746

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator = args[:creator] if args.key?(:creator)
  @environment_config = args[:environment_config] if args.key?(:environment_config)
  @jupyter_session = args[:jupyter_session] if args.key?(:jupyter_session)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @runtime_config = args[:runtime_config] if args.key?(:runtime_config)
  @runtime_info = args[:runtime_info] if args.key?(:runtime_info)
  @session_template = args[:session_template] if args.key?(:session_template)
  @state = args[:state] if args.key?(:state)
  @state_history = args[:state_history] if args.key?(:state_history)
  @state_message = args[:state_message] if args.key?(:state_message)
  @state_time = args[:state_time] if args.key?(:state_time)
  @user = args[:user] if args.key?(:user)
  @uuid = args[:uuid] if args.key?(:uuid)
end