Interface SessionOrBuilder (4.42.0)

Version 4.42.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface SessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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.

getEnvironmentConfig()

public abstract 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.

getEnvironmentConfigOrBuilder()

public abstract 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 abstract 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.

getJupyterSessionOrBuilder()

public abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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

getName()

public abstract 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 abstract 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 abstract 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.

getRuntimeConfigOrBuilder()

public abstract 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 abstract 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.

getRuntimeInfoOrBuilder()

public abstract 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 abstract Session.SessionConfigCase getSessionConfigCase()

Returns
Type	Description
Session.SessionConfigCase

getSessionTemplate()

public abstract 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 abstract 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 abstract 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 abstract 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

getStateHistoryCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getStateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.