Google Cloud Dataproc V1 Client - Class SessionTemplate (2.1.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class SessionTemplate.

A representation of a session template.

Generated from protobuf message google.cloud.dataproc.v1.SessionTemplate

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the session template.
↳ description string

Optional. Brief description of the template.
↳ create_time Google\Protobuf\Timestamp

Output only. The time when the template was created.
↳ jupyter_session Google\Cloud\Dataproc\V1\JupyterConfig

Optional. Jupyter session config.
↳ spark_connect_session Google\Cloud\Dataproc\V1\SparkConnectConfig

Optional. Spark Connect session config.
↳ creator string

Output only. The email address of the user who created the template.
↳ labels array|Google\Protobuf\Internal\MapField

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.
↳ runtime_config Google\Cloud\Dataproc\V1\RuntimeConfig

Optional. Runtime configuration for session execution.
↳ environment_config Google\Cloud\Dataproc\V1\EnvironmentConfig

Optional. Environment configuration for session execution.
↳ update_time Google\Protobuf\Timestamp

Output only. The time the template was last updated.
↳ uuid string

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

getName

Required. The resource name of the session template.

Returns
Type Description
string

setName

Required. The resource name of the session template.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Brief description of the template.

Returns
Type Description
string

setDescription

Optional. Brief description of the template.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time when the template was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the template was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getJupyterSession

Optional. Jupyter session config.

Returns
Type Description
Google\Cloud\Dataproc\V1\JupyterConfig|null

hasJupyterSession

setJupyterSession

Optional. Jupyter session config.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\JupyterConfig
Returns
Type Description
$this

getSparkConnectSession

Optional. Spark Connect session config.

Returns
Type Description
Google\Cloud\Dataproc\V1\SparkConnectConfig|null

hasSparkConnectSession

setSparkConnectSession

Optional. Spark Connect session config.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\SparkConnectConfig
Returns
Type Description
$this

getCreator

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

Returns
Type Description
string

setCreator

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getRuntimeConfig

Optional. Runtime configuration for session execution.

Returns
Type Description
Google\Cloud\Dataproc\V1\RuntimeConfig|null

hasRuntimeConfig

clearRuntimeConfig

setRuntimeConfig

Optional. Runtime configuration for session execution.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\RuntimeConfig
Returns
Type Description
$this

getEnvironmentConfig

Optional. Environment configuration for session execution.

Returns
Type Description
Google\Cloud\Dataproc\V1\EnvironmentConfig|null

hasEnvironmentConfig

clearEnvironmentConfig

setEnvironmentConfig

Optional. Environment configuration for session execution.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\EnvironmentConfig
Returns
Type Description
$this

getUpdateTime

Output only. The time the template was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the template was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUuid

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

Returns
Type Description
string

setUuid

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSessionConfig

Returns
Type Description
string