public final class Session extends GeneratedMessageV3 implements SessionOrBuilder
A representation of a session.
Protobuf type google.cloud.dataproc.v1.Session
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATOR_FIELD_NUMBER
public static final int CREATOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENVIRONMENT_CONFIG_FIELD_NUMBER
public static final int ENVIRONMENT_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
JUPYTER_SESSION_FIELD_NUMBER
public static final int JUPYTER_SESSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RUNTIME_CONFIG_FIELD_NUMBER
public static final int RUNTIME_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RUNTIME_INFO_FIELD_NUMBER
public static final int RUNTIME_INFO_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SESSION_TEMPLATE_FIELD_NUMBER
public static final int SESSION_TEMPLATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_HISTORY_FIELD_NUMBER
public static final int STATE_HISTORY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_MESSAGE_FIELD_NUMBER
public static final int STATE_MESSAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_TIME_FIELD_NUMBER
public static final int STATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_FIELD_NUMBER
public static final int USER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UUID_FIELD_NUMBER
public static final int UUID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Session getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Session.Builder newBuilder()
newBuilder(Session prototype)
public static Session.Builder newBuilder(Session prototype)
| Parameter |
|---|
| Name | Description |
prototype | Session
|
public static Session parseDelimitedFrom(InputStream input)
public static Session parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Session parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Session parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom(CodedInputStream input)
public static Session parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom(InputStream input)
public static Session parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Session parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Session> parser()
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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 |
|---|
| Type | Description |
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];
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()
getEnvironmentConfig()
public EnvironmentConfig getEnvironmentConfig()
Optional. Environment configuration for the session execution.
.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];
getEnvironmentConfigOrBuilder()
public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()
Optional. Environment configuration for the session execution.
.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];
getJupyterSession()
public JupyterConfig getJupyterSession()
Optional. Jupyter session config.
.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];
getJupyterSessionOrBuilder()
public JupyterConfigOrBuilder getJupyterSessionOrBuilder()
Optional. Jupyter session config.
.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
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
|
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.
|
getParserForType()
public Parser<Session> getParserForType()
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];
getRuntimeConfigOrBuilder()
public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
Optional. Runtime configuration for the session execution.
.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSessionConfigCase()
public Session.SessionConfigCase getSessionConfigCase()
getSessionTemplate()
public String getSessionTemplate()
Optional. The session template used by the session.
Only resource names, including project ID and location, are valid.
Example:
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:
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];
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
|
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];
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
|
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.
|
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];
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()
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()
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Session.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Session.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Session.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
