Class Session.Builder (4.39.0) 

public static final class Session.Builder extends GeneratedMessageV3.Builder<Session.Builder> implements SessionOrBuilder

A representation of a session.

Protobuf type google.cloud.dataproc.v1.Session

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Session.Builder

Implements

SessionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllStateHistory(Iterable<? extends Session.SessionStateHistory> values)

public Session.Builder addAllStateHistory(Iterable<? extends Session.SessionStateHistory> values)

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
Name Description
values Iterable<? extends com.google.cloud.dataproc.v1.Session.SessionStateHistory>
Returns
Type Description
Session.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Session.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Session.Builder
Overrides

addStateHistory(Session.SessionStateHistory value)

public Session.Builder addStateHistory(Session.SessionStateHistory value)

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
Name Description
value Session.SessionStateHistory
Returns
Type Description
Session.Builder

addStateHistory(Session.SessionStateHistory.Builder builderForValue)

public Session.Builder addStateHistory(Session.SessionStateHistory.Builder builderForValue)

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
Name Description
builderForValue Session.SessionStateHistory.Builder
Returns
Type Description
Session.Builder

addStateHistory(int index, Session.SessionStateHistory value)

public Session.Builder addStateHistory(int index, Session.SessionStateHistory value)

Output only. Historical state information for the session.

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

Parameters
Name Description
index int
value Session.SessionStateHistory
Returns
Type Description
Session.Builder

addStateHistory(int index, Session.SessionStateHistory.Builder builderForValue)

public Session.Builder addStateHistory(int index, Session.SessionStateHistory.Builder builderForValue)

Output only. Historical state information for the session.

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

Parameters
Name Description
index int
builderForValue Session.SessionStateHistory.Builder
Returns
Type Description
Session.Builder

addStateHistoryBuilder()

public Session.SessionStateHistory.Builder addStateHistoryBuilder()

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
Type Description
Session.SessionStateHistory.Builder

addStateHistoryBuilder(int index)

public Session.SessionStateHistory.Builder addStateHistoryBuilder(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
Name Description
index int
Returns
Type Description
Session.SessionStateHistory.Builder

build()

public Session build()
Returns
Type Description
Session

buildPartial()

public Session buildPartial()
Returns
Type Description
Session

clear()

public Session.Builder clear()
Returns
Type Description
Session.Builder
Overrides

clearCreateTime()

public Session.Builder clearCreateTime()

Output only. The time when the session was created.

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

Returns
Type Description
Session.Builder

clearCreator()

public Session.Builder clearCreator()

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

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearEnvironmentConfig()

public Session.Builder clearEnvironmentConfig()

Optional. Environment configuration for the session execution.

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

Returns
Type Description
Session.Builder

clearField(Descriptors.FieldDescriptor field)

public Session.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Session.Builder
Overrides

clearJupyterSession()

public Session.Builder clearJupyterSession()

Optional. Jupyter session config.

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

Returns
Type Description
Session.Builder

clearLabels()

public Session.Builder clearLabels()
Returns
Type Description
Session.Builder

clearName()

public Session.Builder clearName()

Required. The resource name of the session.

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Session.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Session.Builder
Overrides

clearRuntimeConfig()

public Session.Builder clearRuntimeConfig()

Optional. Runtime configuration for the session execution.

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

Returns
Type Description
Session.Builder

clearRuntimeInfo()

public Session.Builder clearRuntimeInfo()

Output only. Runtime information about session execution.

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

Returns
Type Description
Session.Builder

clearSessionConfig()

public Session.Builder clearSessionConfig()
Returns
Type Description
Session.Builder

clearSessionTemplate()

public Session.Builder clearSessionTemplate()

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
Type Description
Session.Builder

This builder for chaining.

clearState()

public Session.Builder clearState()

Output only. A state of the session.

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearStateHistory()

public Session.Builder clearStateHistory()

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
Type Description
Session.Builder

clearStateMessage()

public Session.Builder clearStateMessage()

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
Type Description
Session.Builder

This builder for chaining.

clearStateTime()

public Session.Builder clearStateTime()

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

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

Returns
Type Description
Session.Builder

clearUser()

public Session.Builder clearUser()

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

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearUuid()

public Session.Builder clearUuid()

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
Type Description
Session.Builder

This builder for chaining.

clone()

public Session.Builder clone()
Returns
Type Description
Session.Builder
Overrides

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
Name Description
key String
Returns
Type Description
boolean

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
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the session was created.

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

Returns
Type Description
Builder

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for creator.

getDefaultInstanceForType()

public Session getDefaultInstanceForType()
Returns
Type Description
Session

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
EnvironmentConfig

The environmentConfig.

getEnvironmentConfigBuilder()

public EnvironmentConfig.Builder getEnvironmentConfigBuilder()

Optional. Environment configuration for the session execution.

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

Returns
Type Description
EnvironmentConfig.Builder

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
Type Description
EnvironmentConfigOrBuilder

getJupyterSession()

public JupyterConfig getJupyterSession()

Optional. Jupyter session config.

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

Returns
Type Description
JupyterConfig

The jupyterSession.

getJupyterSessionBuilder()

public JupyterConfig.Builder getJupyterSessionBuilder()

Optional. Jupyter session config.

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

Returns
Type Description
JupyterConfig.Builder

getJupyterSessionOrBuilder()

public JupyterConfigOrBuilder getJupyterSessionOrBuilder()

Optional. Jupyter session config.

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

Returns
Type Description
JupyterConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Required. The resource name of the session.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the session.

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

Returns
Type Description
ByteString

The bytes for name.

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
Type Description
RuntimeConfig

The runtimeConfig.

getRuntimeConfigBuilder()

public RuntimeConfig.Builder getRuntimeConfigBuilder()

Optional. Runtime configuration for the session execution.

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

Returns
Type Description
RuntimeConfig.Builder

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
Type Description
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
Type Description
RuntimeInfo

The runtimeInfo.

getRuntimeInfoBuilder()

public RuntimeInfo.Builder getRuntimeInfoBuilder()

Output only. Runtime information about session execution.

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

Returns
Type Description
RuntimeInfo.Builder

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
Type Description
RuntimeInfoOrBuilder

getSessionConfigCase()

public Session.SessionConfigCase getSessionConfigCase()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
Session.SessionStateHistory

getStateHistoryBuilder(int index)

public Session.SessionStateHistory.Builder getStateHistoryBuilder(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
Name Description
index int
Returns
Type Description
Session.SessionStateHistory.Builder

getStateHistoryBuilderList()

public List<Session.SessionStateHistory.Builder> getStateHistoryBuilderList()

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
Type Description
List<Builder>

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
Timestamp

The stateTime.

getStateTimeBuilder()

public Timestamp.Builder getStateTimeBuilder()

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

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

Returns
Type Description
Builder

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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the stateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Session.Builder mergeCreateTime(Timestamp value)

Output only. The time when the session was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

mergeEnvironmentConfig(EnvironmentConfig value)

public Session.Builder mergeEnvironmentConfig(EnvironmentConfig value)

Optional. Environment configuration for the session execution.

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

Parameter
Name Description
value EnvironmentConfig
Returns
Type Description
Session.Builder

mergeFrom(Session other)

public Session.Builder mergeFrom(Session other)
Parameter
Name Description
other Session
Returns
Type Description
Session.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Session.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Session.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Session.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Session.Builder
Overrides

mergeJupyterSession(JupyterConfig value)

public Session.Builder mergeJupyterSession(JupyterConfig value)

Optional. Jupyter session config.

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

Parameter
Name Description
value JupyterConfig
Returns
Type Description
Session.Builder

mergeRuntimeConfig(RuntimeConfig value)

public Session.Builder mergeRuntimeConfig(RuntimeConfig value)

Optional. Runtime configuration for the session execution.

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

Parameter
Name Description
value RuntimeConfig
Returns
Type Description
Session.Builder

mergeRuntimeInfo(RuntimeInfo value)

public Session.Builder mergeRuntimeInfo(RuntimeInfo value)

Output only. Runtime information about session execution.

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

Parameter
Name Description
value RuntimeInfo
Returns
Type Description
Session.Builder

mergeStateTime(Timestamp value)

public Session.Builder mergeStateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

putAllLabels(Map<String,String> values)

public Session.Builder putAllLabels(Map<String,String> values)

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
Name Description
values Map<String,String>
Returns
Type Description
Session.Builder

putLabels(String key, String value)

public Session.Builder putLabels(String key, String value)

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
Name Description
key String
value String
Returns
Type Description
Session.Builder

removeLabels(String key)

public Session.Builder removeLabels(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
Name Description
key String
Returns
Type Description
Session.Builder

removeStateHistory(int index)

public Session.Builder removeStateHistory(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
Name Description
index int
Returns
Type Description
Session.Builder

setCreateTime(Timestamp value)

public Session.Builder setCreateTime(Timestamp value)

Output only. The time when the session was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Session.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the session was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Session.Builder

setCreator(String value)

public Session.Builder setCreator(String value)

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

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

Parameter
Name Description
value String

The creator to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setCreatorBytes(ByteString value)

public Session.Builder setCreatorBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for creator to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setEnvironmentConfig(EnvironmentConfig value)

public Session.Builder setEnvironmentConfig(EnvironmentConfig value)

Optional. Environment configuration for the session execution.

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

Parameter
Name Description
value EnvironmentConfig
Returns
Type Description
Session.Builder

setEnvironmentConfig(EnvironmentConfig.Builder builderForValue)

public Session.Builder setEnvironmentConfig(EnvironmentConfig.Builder builderForValue)

Optional. Environment configuration for the session execution.

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

Parameter
Name Description
builderForValue EnvironmentConfig.Builder
Returns
Type Description
Session.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Session.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Session.Builder
Overrides

setJupyterSession(JupyterConfig value)

public Session.Builder setJupyterSession(JupyterConfig value)

Optional. Jupyter session config.

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

Parameter
Name Description
value JupyterConfig
Returns
Type Description
Session.Builder

setJupyterSession(JupyterConfig.Builder builderForValue)

public Session.Builder setJupyterSession(JupyterConfig.Builder builderForValue)

Optional. Jupyter session config.

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

Parameter
Name Description
builderForValue JupyterConfig.Builder
Returns
Type Description
Session.Builder

setName(String value)

public Session.Builder setName(String value)

Required. The resource name of the session.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Session.Builder setNameBytes(ByteString value)

Required. The resource name of the session.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Session.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Session.Builder
Overrides

setRuntimeConfig(RuntimeConfig value)

public Session.Builder setRuntimeConfig(RuntimeConfig value)

Optional. Runtime configuration for the session execution.

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

Parameter
Name Description
value RuntimeConfig
Returns
Type Description
Session.Builder

setRuntimeConfig(RuntimeConfig.Builder builderForValue)

public Session.Builder setRuntimeConfig(RuntimeConfig.Builder builderForValue)

Optional. Runtime configuration for the session execution.

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

Parameter
Name Description
builderForValue RuntimeConfig.Builder
Returns
Type Description
Session.Builder

setRuntimeInfo(RuntimeInfo value)

public Session.Builder setRuntimeInfo(RuntimeInfo value)

Output only. Runtime information about session execution.

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

Parameter
Name Description
value RuntimeInfo
Returns
Type Description
Session.Builder

setRuntimeInfo(RuntimeInfo.Builder builderForValue)

public Session.Builder setRuntimeInfo(RuntimeInfo.Builder builderForValue)

Output only. Runtime information about session execution.

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

Parameter
Name Description
builderForValue RuntimeInfo.Builder
Returns
Type Description
Session.Builder

setSessionTemplate(String value)

public Session.Builder setSessionTemplate(String value)

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) = { ... }

Parameter
Name Description
value String

The sessionTemplate to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setSessionTemplateBytes(ByteString value)

public Session.Builder setSessionTemplateBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for sessionTemplate to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setState(Session.State value)

public Session.Builder setState(Session.State value)

Output only. A state of the session.

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

Parameter
Name Description
value Session.State

The state to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setStateHistory(int index, Session.SessionStateHistory value)

public Session.Builder setStateHistory(int index, Session.SessionStateHistory value)

Output only. Historical state information for the session.

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

Parameters
Name Description
index int
value Session.SessionStateHistory
Returns
Type Description
Session.Builder

setStateHistory(int index, Session.SessionStateHistory.Builder builderForValue)

public Session.Builder setStateHistory(int index, Session.SessionStateHistory.Builder builderForValue)

Output only. Historical state information for the session.

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

Parameters
Name Description
index int
builderForValue Session.SessionStateHistory.Builder
Returns
Type Description
Session.Builder

setStateMessage(String value)

public Session.Builder setStateMessage(String value)

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];

Parameter
Name Description
value String

The stateMessage to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setStateMessageBytes(ByteString value)

public Session.Builder setStateMessageBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for stateMessage to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setStateTime(Timestamp value)

public Session.Builder setStateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

setStateTime(Timestamp.Builder builderForValue)

public Session.Builder setStateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Session.Builder

setStateValue(int value)

public Session.Builder setStateValue(int value)

Output only. A state of the session.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

setUser(String value)

public Session.Builder setUser(String value)

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

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

Parameter
Name Description
value String

The user to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setUserBytes(ByteString value)

public Session.Builder setUserBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for user to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setUuid(String value)

public Session.Builder setUuid(String value)

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];

Parameter
Name Description
value String

The uuid to set.
Returns
Type Description
Session.Builder

This builder for chaining.

setUuidBytes(ByteString value)

public Session.Builder setUuidBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for uuid to set.
Returns
Type Description
Session.Builder

This builder for chaining.