Class Session (4.33.0)

public final class Session extends GeneratedMessageV3 implements SessionOrBuilder

A representation of a session.

Protobuf type google.cloud.dataproc.v1.Session

Implements

SessionOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CREATOR_FIELD_NUMBER

public static final int CREATOR_FIELD_NUMBER
Field Value
TypeDescription
int

ENVIRONMENT_CONFIG_FIELD_NUMBER

public static final int ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

JUPYTER_SESSION_FIELD_NUMBER

public static final int JUPYTER_SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RUNTIME_CONFIG_FIELD_NUMBER

public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

RUNTIME_INFO_FIELD_NUMBER

public static final int RUNTIME_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_TEMPLATE_FIELD_NUMBER

public static final int SESSION_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_HISTORY_FIELD_NUMBER

public static final int STATE_HISTORY_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_TIME_FIELD_NUMBER

public static final int STATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

USER_FIELD_NUMBER

public static final int USER_FIELD_NUMBER
Field Value
TypeDescription
int

UUID_FIELD_NUMBER

public static final int UUID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Session getDefaultInstance()
Returns
TypeDescription
Session

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Session.Builder newBuilder()
Returns
TypeDescription
Session.Builder

newBuilder(Session prototype)

public static Session.Builder newBuilder(Session prototype)
Parameter
NameDescription
prototypeSession
Returns
TypeDescription
Session.Builder

parseDelimitedFrom(InputStream input)

public static Session parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Session parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Session parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Session parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Session parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Session parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Session parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Session parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Session parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Session parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Session parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Session parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Session
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Session> parser()
Returns
TypeDescription
Parser<Session>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getCreator()

public String getCreator()

Output only. The email address of the user who created the session.

string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

Output only. The email address of the user who created the session.

string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for creator.

getDefaultInstanceForType()

public Session getDefaultInstanceForType()
Returns
TypeDescription
Session

getEnvironmentConfig()

public EnvironmentConfig getEnvironmentConfig()

Optional. Environment configuration for the session execution.

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EnvironmentConfig

The environmentConfig.

getEnvironmentConfigOrBuilder()

public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()

Optional. Environment configuration for the session execution.

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EnvironmentConfigOrBuilder

getJupyterSession()

public JupyterConfig getJupyterSession()

Optional. Jupyter session config.

.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
JupyterConfig

The jupyterSession.

getJupyterSessionOrBuilder()

public JupyterConfigOrBuilder getJupyterSessionOrBuilder()

Optional. Jupyter session config.

.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
JupyterConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Required. The resource name of the session.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the session.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Session> getParserForType()
Returns
TypeDescription
Parser<Session>
Overrides

getRuntimeConfig()

public RuntimeConfig getRuntimeConfig()

Optional. Runtime configuration for the session execution.

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Optional. Runtime configuration for the session execution.

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RuntimeConfigOrBuilder

getRuntimeInfo()

public RuntimeInfo getRuntimeInfo()

Output only. Runtime information about session execution.

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
RuntimeInfo

The runtimeInfo.

getRuntimeInfoOrBuilder()

public RuntimeInfoOrBuilder getRuntimeInfoOrBuilder()

Output only. Runtime information about session execution.

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
RuntimeInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSessionConfigCase()

public Session.SessionConfigCase getSessionConfigCase()
Returns
TypeDescription
Session.SessionConfigCase

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.

string session_template = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The sessionTemplate.

getSessionTemplateBytes()

public ByteString getSessionTemplateBytes()

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.

string session_template = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for sessionTemplate.

getState()

public Session.State getState()

Output only. A state of the session.

.google.cloud.dataproc.v1.Session.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Session.State

The state.

getStateHistory(int index)

public Session.SessionStateHistory getStateHistory(int index)

Output only. Historical state information for the session.

repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Session.SessionStateHistory

getStateHistoryCount()

public int getStateHistoryCount()

Output only. Historical state information for the session.

repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getStateHistoryList()

public List<Session.SessionStateHistory> getStateHistoryList()

Output only. Historical state information for the session.

repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<SessionStateHistory>

getStateHistoryOrBuilder(int index)

public Session.SessionStateHistoryOrBuilder getStateHistoryOrBuilder(int index)

Output only. Historical state information for the session.

repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Session.SessionStateHistoryOrBuilder

getStateHistoryOrBuilderList()

public List<? extends Session.SessionStateHistoryOrBuilder> getStateHistoryOrBuilderList()

Output only. Historical state information for the session.

repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.dataproc.v1.Session.SessionStateHistoryOrBuilder>

getStateMessage()

public String getStateMessage()

Output only. Session state details, such as the failure description if the state is FAILED.

string state_message = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

Output only. Session state details, such as the failure description if the state is FAILED.

string state_message = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stateMessage.

getStateTime()

public Timestamp getStateTime()

Output only. The time when the session entered the current state.

.google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The stateTime.

getStateTimeOrBuilder()

public TimestampOrBuilder getStateTimeOrBuilder()

Output only. The time when the session entered the current state.

.google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getStateValue()

public int getStateValue()

Output only. A state of the session.

.google.cloud.dataproc.v1.Session.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUser()

public String getUser()

Optional. The email address of the user who owns the session.

string user = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The user.

getUserBytes()

public ByteString getUserBytes()

Optional. The email address of the user who owns the session.

string user = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for user.

getUuid()

public String getUuid()

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

string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uuid.

getUuidBytes()

public ByteString getUuidBytes()

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

string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uuid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEnvironmentConfig()

public boolean hasEnvironmentConfig()

Optional. Environment configuration for the session execution.

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the environmentConfig field is set.

hasJupyterSession()

public boolean hasJupyterSession()

Optional. Jupyter session config.

.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the jupyterSession field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Optional. Runtime configuration for the session execution.

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the runtimeConfig field is set.

hasRuntimeInfo()

public boolean hasRuntimeInfo()

Output only. Runtime information about session execution.

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the runtimeInfo field is set.

hasStateTime()

public boolean hasStateTime()

Output only. The time when the session entered the current state.

.google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the stateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Session.Builder newBuilderForType()
Returns
TypeDescription
Session.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Session.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Session.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Session.Builder toBuilder()
Returns
TypeDescription
Session.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException