Session (Cloud Dataproc API v1-rev20231002-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataproc.model.Session

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Session
extends com.google.api.client.json.GenericJson
```
A representation of a session.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Session()

Constructors
Constructor and Description
`Session()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Session`	`clone()`
`String`	`getCreateTime()` Output only.
`String`	`getCreator()` Output only.
`EnvironmentConfig`	`getEnvironmentConfig()` Optional.
`JupyterConfig`	`getJupyterSession()` Optional.
`Map<String,String>`	`getLabels()` Optional.
`String`	`getName()` Required.
`RuntimeConfig`	`getRuntimeConfig()` Optional.
`RuntimeInfo`	`getRuntimeInfo()` Output only.
`String`	`getSessionTemplate()` Optional.
`String`	`getState()` Output only.
`List<SessionStateHistory>`	`getStateHistory()` Output only.
`String`	`getStateMessage()` Output only.
`String`	`getStateTime()` Output only.
`String`	`getUser()` Optional.
`String`	`getUuid()` Output only.
`Session`	`set(String fieldName, Object value)`
`Session`	`setCreateTime(String createTime)` Output only.
`Session`	`setCreator(String creator)` Output only.
`Session`	`setEnvironmentConfig(EnvironmentConfig environmentConfig)` Optional.
`Session`	`setJupyterSession(JupyterConfig jupyterSession)` Optional.
`Session`	`setLabels(Map<String,String> labels)` Optional.
`Session`	`setName(String name)` Required.
`Session`	`setRuntimeConfig(RuntimeConfig runtimeConfig)` Optional.
`Session`	`setRuntimeInfo(RuntimeInfo runtimeInfo)` Output only.
`Session`	`setSessionTemplate(String sessionTemplate)` Optional.
`Session`	`setState(String state)` Output only.
`Session`	`setStateHistory(List<SessionStateHistory> stateHistory)` Output only.
`Session`	`setStateMessage(String stateMessage)` Output only.
`Session`	`setStateTime(String stateTime)` Output only.
`Session`	`setUser(String user)` Optional.
`Session`	`setUuid(String uuid)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Session
```
public Session()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time when the session was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Session setCreateTime(String createTime)
```
    Output only. The time when the session was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCreator
```
public String getCreator()
```
    Output only. The email address of the user who created the session.
    
    Returns:
    
    value or null for none
  - setCreator
```
public Session setCreator(String creator)
```
    Output only. The email address of the user who created the session.
    
    Parameters:
    
    creator - creator or null for none
  - getEnvironmentConfig
```
public EnvironmentConfig getEnvironmentConfig()
```
    Optional. Environment configuration for the session execution.
    
    Returns:
    
    value or null for none
  - setEnvironmentConfig
```
public Session setEnvironmentConfig(EnvironmentConfig environmentConfig)
```
    Optional. Environment configuration for the session execution.
    
    Parameters:
    
    environmentConfig - environmentConfig or null for none
  - getJupyterSession
```
public JupyterConfig getJupyterSession()
```
    Optional. Jupyter session config.
    
    Returns:
    
    value or null for none
  - setJupyterSession
```
public Session setJupyterSession(JupyterConfig jupyterSession)
```
    Optional. Jupyter session config.
    
    Parameters:
    
    jupyterSession - jupyterSession or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Session setLabels(Map<String,String> labels)
```
    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.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Required. The resource name of the session.
    
    Returns:
    
    value or null for none
  - setName
```
public Session setName(String name)
```
    Required. The resource name of the session.
    
    Parameters:
    
    name - name or null for none
  - getRuntimeConfig
```
public RuntimeConfig getRuntimeConfig()
```
    Optional. Runtime configuration for the session execution.
    
    Returns:
    
    value or null for none
  - setRuntimeConfig
```
public Session setRuntimeConfig(RuntimeConfig runtimeConfig)
```
    Optional. Runtime configuration for the session execution.
    
    Parameters:
    
    runtimeConfig - runtimeConfig or null for none
  - getRuntimeInfo
```
public RuntimeInfo getRuntimeInfo()
```
    Output only. Runtime information about session execution.
    
    Returns:
    
    value or null for none
  - setRuntimeInfo
```
public Session setRuntimeInfo(RuntimeInfo runtimeInfo)
```
    Output only. Runtime information about session execution.
    
    Parameters:
    
    runtimeInfo - runtimeInfo or null for none
  - getSessionTemplate
```
public String getSessionTemplate()
```
    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.
    
    Returns:
    
    value or null for none
  - setSessionTemplate
```
public Session setSessionTemplate(String sessionTemplate)
```
    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.
    
    Parameters:
    
    sessionTemplate - sessionTemplate or null for none
  - getState
```
public String getState()
```
    Output only. A state of the session.
    
    Returns:
    
    value or null for none
  - setState
```
public Session setState(String state)
```
    Output only. A state of the session.
    
    Parameters:
    
    state - state or null for none
  - getStateHistory
```
public List<SessionStateHistory> getStateHistory()
```
    Output only. Historical state information for the session.
    
    Returns:
    
    value or null for none
  - setStateHistory
```
public Session setStateHistory(List<SessionStateHistory> stateHistory)
```
    Output only. Historical state information for the session.
    
    Parameters:
    
    stateHistory - stateHistory or null for none
  - getStateMessage
```
public String getStateMessage()
```
    Output only. Session state details, such as the failure description if the state is FAILED.
    
    Returns:
    
    value or null for none
  - setStateMessage
```
public Session setStateMessage(String stateMessage)
```
    Output only. Session state details, such as the failure description if the state is FAILED.
    
    Parameters:
    
    stateMessage - stateMessage or null for none
  - getStateTime
```
public String getStateTime()
```
    Output only. The time when the session entered the current state.
    
    Returns:
    
    value or null for none
  - setStateTime
```
public Session setStateTime(String stateTime)
```
    Output only. The time when the session entered the current state.
    
    Parameters:
    
    stateTime - stateTime or null for none
  - getUser
```
public String getUser()
```
    Optional. The email address of the user who owns the session.
    
    Returns:
    
    value or null for none
  - setUser
```
public Session setUser(String user)
```
    Optional. The email address of the user who owns the session.
    
    Parameters:
    
    user - user or null for none
  - getUuid
```
public String getUuid()
```
    Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    
    Returns:
    
    value or null for none
  - setUuid
```
public Session setUuid(String uuid)
```
    Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    
    Parameters:
    
    uuid - uuid or null for none
  - set
```
public Session set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Session clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Session

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Session

Method Detail

getCreateTime

setCreateTime

getCreator

setCreator

getEnvironmentConfig

setEnvironmentConfig

getJupyterSession

setJupyterSession

getLabels

setLabels

getName

setName

getRuntimeConfig

setRuntimeConfig

getRuntimeInfo

setRuntimeInfo

getSessionTemplate

setSessionTemplate

getState

setState

getStateHistory

setStateHistory

getStateMessage

setStateMessage

getStateTime

setStateTime

getUser

setUser

getUuid

setUuid

set

clone