Class SessionTemplate (4.44.0) 

public final class SessionTemplate extends GeneratedMessageV3 implements SessionTemplateOrBuilder

A representation of a session template.

Protobuf type google.cloud.dataproc.v1.SessionTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SessionTemplate

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

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_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 SessionTemplate getDefaultInstance()
Returns
Type Description
SessionTemplate

getDescriptor()

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

newBuilder()

public static SessionTemplate.Builder newBuilder()
Returns
Type Description
SessionTemplate.Builder

newBuilder(SessionTemplate prototype)

public static SessionTemplate.Builder newBuilder(SessionTemplate prototype)
Parameter
Name Description
prototype SessionTemplate
Returns
Type Description
SessionTemplate.Builder

parseDelimitedFrom(InputStream input)

public static SessionTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SessionTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SessionTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SessionTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SessionTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SessionTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SessionTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SessionTemplate> parser()
Returns
Type Description
Parser<SessionTemplate>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the template was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the template was created.

.google.protobuf.Timestamp create_time = 2 [(.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 template.

string creator = 5 [(.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 template.

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

Returns
Type Description
ByteString

The bytes for creator.

getDefaultInstanceForType()

public SessionTemplate getDefaultInstanceForType()
Returns
Type Description
SessionTemplate

getDescription()

public String getDescription()

Optional. Brief description of the template.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Brief description of the template.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEnvironmentConfig()

public EnvironmentConfig getEnvironmentConfig()

Optional. Environment configuration for session execution.

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

Returns
Type Description
EnvironmentConfig

The environmentConfig.

getEnvironmentConfigOrBuilder()

public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()

Optional. Environment configuration for session execution.

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

Returns
Type Description
EnvironmentConfigOrBuilder

getJupyterSession()

public JupyterConfig getJupyterSession()

Optional. Jupyter session config.

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

Returns
Type Description
JupyterConfig

The jupyterSession.

getJupyterSessionOrBuilder()

public JupyterConfigOrBuilder getJupyterSessionOrBuilder()

Optional. Jupyter session config.

.google.cloud.dataproc.v1.JupyterConfig jupyter_session = 3 [(.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. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

map<string, string> labels = 6 [(.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. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Required. The resource name of the session template.

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 template.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SessionTemplate> getParserForType()
Returns
Type Description
Parser<SessionTemplate>
Overrides

getRuntimeConfig()

public RuntimeConfig getRuntimeConfig()

Optional. Runtime configuration for session execution.

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

Returns
Type Description
RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Optional. Runtime configuration for session execution.

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

Returns
Type Description
RuntimeConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionConfigCase()

public SessionTemplate.SessionConfigCase getSessionConfigCase()
Returns
Type Description
SessionTemplate.SessionConfigCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the template was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the template was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUuid()

public String getUuid()

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

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

Returns
Type Description
String

The uuid.

getUuidBytes()

public ByteString getUuidBytes()

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

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

Returns
Type Description
ByteString

The bytes for uuid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the template was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasEnvironmentConfig()

public boolean hasEnvironmentConfig()

Optional. Environment configuration for session execution.

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 8 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the jupyterSession field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Optional. Runtime configuration for session execution.

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

Returns
Type Description
boolean

Whether the runtimeConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the template was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SessionTemplate.Builder newBuilderForType()
Returns
Type Description
SessionTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SessionTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SessionTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SessionTemplate.Builder toBuilder()
Returns
Type Description
SessionTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException