Google Cloud Dataproc V1 Client - Class CreateSessionRequest (3.13.4)

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

A request to create a session.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource where this session will be created.

↳ session Google\Cloud\Dataproc\V1\Session

Required. The interactive session to create.

↳ session_id string

Required. The ID to use for the session, which becomes the final component of the session's resource name. This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

↳ request_id string

Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequestss with the same ID, the second request is ignored, and the first Session is created and stored in the backend. Recommendation: Set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

getParent

Required. The parent resource where this session will be created.

Returns
Type Description
string

setParent

Required. The parent resource where this session will be created.

Parameter
Name Description
var string
Returns
Type Description
$this

getSession

Required. The interactive session to create.

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

hasSession

clearSession

setSession

Required. The interactive session to create.

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

getSessionId

Required. The ID to use for the session, which becomes the final component of the session's resource name.

This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

Returns
Type Description
string

setSessionId

Required. The ID to use for the session, which becomes the final component of the session's resource name.

This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequestss with the same ID, the second request is ignored, and the first Session is created and stored in the backend.

Recommendation: Set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns
Type Description
string

setRequestId

Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequestss with the same ID, the second request is ignored, and the first Session is created and stored in the backend.

Recommendation: Set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource where this session will be created. Please see Google\Cloud\Dataproc\V1\SessionControllerClient::locationName() for help formatting this field.

session Google\Cloud\Dataproc\V1\Session

Required. The interactive session to create.

sessionId string

Required. The ID to use for the session, which becomes the final component of the session's resource name.

This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

Returns
Type Description
Google\Cloud\Dataproc\V1\CreateSessionRequest