Google Cloud Dataplex V1 Client - Class Session (0.13.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Session.

Represents an active analyze session running for a user.

Generated from protobuf message google.cloud.dataplex.v1.Session

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}
`↳ user_id`	`string` Output only. Email of user running the session.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Session start time.
`↳ state`	`int` Output only. State of Session

getName

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}

Returns
Type	Description
`string`

setName

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUserId

Output only. Email of user running the session.

Returns
Type	Description
`string`

setUserId

Output only. Email of user running the session.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Session start time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Session start time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. State of Session

Returns
Type	Description
`int`

setState

Output only. State of Session

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`