Google Cloud Dataproc V1 Client - Class TerminateSessionRequest (2.0.0-RC1)

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

A request to terminate an interactive session.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the session resource to terminate.

↳ request_id string

Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequests with the same ID, the second request is ignored. 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.

getName

Required. The name of the session resource to terminate.

Returns
Type Description
string

setName

Required. The name of the session resource to terminate.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequests with the same ID, the second request is ignored.

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 TerminateSessionRequests with the same ID, the second request is ignored.

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

Parameter
Name Description
name string

Required. The name of the session resource to terminate. Please see Google\Cloud\Dataproc\V1\SessionControllerClient::sessionName() for help formatting this field.

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