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 in the service. Next ID: 18

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Session

Returns a new instance of Session.



4575
4576
4577
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4575

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) 


4492
4493
4494
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4492

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) 


4497
4498
4499
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4497

def creator
  @creator
end

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

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

Returns:



4502
4503
4504
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4502

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:



4507
4508
4509
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4507

def jupyter_session
  @jupyter_session
end

#labels ⇒ Hash<String,String>

Optional. The labels to associate with this 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>) 


4516
4517
4518
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4516

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


4521
4522
4523
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4521

def name
  @name
end

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

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

Returns:



4526
4527
4528
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4526

def runtime_config
  @runtime_config
end

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

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

Returns:



4531
4532
4533
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4531

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]Note that the template must be in the same project and Dataproc region. Corresponds to the JSON property sessionTemplate

Returns:

  • (String) 


4541
4542
4543
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4541

def session_template
  @session_template
end

#state ⇒ String

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

Returns:

  • (String) 


4546
4547
4548
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4546

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:



4551
4552
4553
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4551

def state_history
  @state_history
end

#state_message ⇒ String

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

Returns:

  • (String) 


4557
4558
4559
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4557

def state_message
  @state_message
end

#state_time ⇒ String

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

Returns:

  • (String) 


4562
4563
4564
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4562

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) 


4567
4568
4569
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4567

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) 


4573
4574
4575
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4573

def uuid
  @uuid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4580

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