com.google.cloud.dataproc.v1

Interface SessionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Session, Session.Builder

public interface SessionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getCreator() Output only.
com.google.protobuf.ByteString	getCreatorBytes() Output only.
EnvironmentConfig	getEnvironmentConfig() Optional.
EnvironmentConfigOrBuilder	getEnvironmentConfigOrBuilder() Optional.
JupyterConfig	getJupyterSession() Optional.
JupyterConfigOrBuilder	getJupyterSessionOrBuilder() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
RuntimeConfig	getRuntimeConfig() Optional.
RuntimeConfigOrBuilder	getRuntimeConfigOrBuilder() Optional.
RuntimeInfo	getRuntimeInfo() Output only.
RuntimeInfoOrBuilder	getRuntimeInfoOrBuilder() Output only.
Session.SessionConfigCase	getSessionConfigCase()
String	getSessionTemplate() Optional.
com.google.protobuf.ByteString	getSessionTemplateBytes() Optional.
Session.State	getState() Output only.
Session.SessionStateHistory	getStateHistory(int index) Output only.
int	getStateHistoryCount() Output only.
List<Session.SessionStateHistory>	getStateHistoryList() Output only.
Session.SessionStateHistoryOrBuilder	getStateHistoryOrBuilder(int index) Output only.
List<? extends Session.SessionStateHistoryOrBuilder>	getStateHistoryOrBuilderList() Output only.
String	getStateMessage() Output only.
com.google.protobuf.ByteString	getStateMessageBytes() Output only.
com.google.protobuf.Timestamp	getStateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStateTimeOrBuilder() Output only.
int	getStateValue() Output only.
String	getUser() Optional.
com.google.protobuf.ByteString	getUserBytes() Optional.
String	getUuid() Output only.
com.google.protobuf.ByteString	getUuidBytes() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEnvironmentConfig() Optional.
boolean	hasJupyterSession() Optional.
boolean	hasRuntimeConfig() Optional.
boolean	hasRuntimeInfo() Output only.
boolean	hasStateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The resource name of the session.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the session.
 

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

Returns:

The bytes for name.

getUuid

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:

The uuid.

getUuidBytes

com.google.protobuf.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:

The bytes for uuid.

hasCreateTime

boolean hasCreateTime()

 Output only. The time when the session was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. The time when the session was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time when the session was created.
 

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

hasJupyterSession

boolean hasJupyterSession()

 Optional. Jupyter session config.
 

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

Returns:

Whether the jupyterSession field is set.

getJupyterSession

JupyterConfig getJupyterSession()

 Optional. Jupyter session config.
 

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

Returns:

The jupyterSession.

getJupyterSessionOrBuilder

JupyterConfigOrBuilder getJupyterSessionOrBuilder()

 Optional. Jupyter session config.
 

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

hasRuntimeInfo

boolean hasRuntimeInfo()

 Output only. Runtime information about session execution.
 

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

Returns:

Whether the runtimeInfo field is set.

getRuntimeInfo

RuntimeInfo getRuntimeInfo()

 Output only. Runtime information about session execution.
 

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

Returns:

The runtimeInfo.

getRuntimeInfoOrBuilder

RuntimeInfoOrBuilder getRuntimeInfoOrBuilder()

 Output only. Runtime information about session execution.
 

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

getStateValue

int getStateValue()

 Output only. A state of the session.
 

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

Returns:

The enum numeric value on the wire for state.

getState

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:

The state.

getStateMessage

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:

The stateMessage.

getStateMessageBytes

com.google.protobuf.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:

The bytes for stateMessage.

hasStateTime

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:

Whether the stateTime field is set.

getStateTime

com.google.protobuf.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:

The stateTime.

getStateTimeOrBuilder

com.google.protobuf.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];

getCreator

String getCreator()

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

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

Returns:

The creator.

getCreatorBytes

com.google.protobuf.ByteString getCreatorBytes()

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

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

Returns:

The bytes for creator.

getLabelsCount

int getLabelsCount()

 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.
 

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

containsLabels

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](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.
 

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

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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](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.
 

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

getLabelsOrDefault

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](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.
 

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

getLabelsOrThrow

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](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.
 

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

hasRuntimeConfig

boolean hasRuntimeConfig()

 Optional. Runtime configuration for the session execution.
 

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

Returns:

Whether the runtimeConfig field is set.

getRuntimeConfig

RuntimeConfig getRuntimeConfig()

 Optional. Runtime configuration for the session execution.
 

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

Returns:

The runtimeConfig.

getRuntimeConfigOrBuilder

RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

 Optional. Runtime configuration for the session execution.
 

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

hasEnvironmentConfig

boolean hasEnvironmentConfig()

 Optional. Environment configuration for the session execution.
 

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

Returns:

Whether the environmentConfig field is set.

getEnvironmentConfig

EnvironmentConfig getEnvironmentConfig()

 Optional. Environment configuration for the session execution.
 

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

Returns:

The environmentConfig.

getEnvironmentConfigOrBuilder

EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()

 Optional. Environment configuration for the session execution.
 

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

getUser

String getUser()

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

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

Returns:

The user.

getUserBytes

com.google.protobuf.ByteString getUserBytes()

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

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

Returns:

The bytes for user.

getStateHistoryList

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

getStateHistory

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

getStateHistoryCount

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

getStateHistoryOrBuilderList

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

getStateHistoryOrBuilder

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

getSessionTemplate

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:

The sessionTemplate.

getSessionTemplateBytes

com.google.protobuf.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:

The bytes for sessionTemplate.

getSessionConfigCase

Session.SessionConfigCase getSessionConfigCase()