Google Cloud Dataplex V1 Client - Class SessionEvent (1.0.0-RC1)

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

These messages contain information about sessions within an environment.

The monitored resource is 'Environment'.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ message string

The log message.

↳ user_id string

The information about the user that created the session. It will be the email address of the user.

↳ session_id string

Unique identifier for the session.

↳ type int

The type of the event.

↳ query Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail

The execution details of the query.

↳ event_succeeded bool

The status of the event.

↳ fast_startup_enabled bool

If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.

↳ unassigned_duration Google\Protobuf\Duration

The idle duration of a warm pooled session before it is assigned to user.

getMessage

The log message.

Returns
Type Description
string

setMessage

The log message.

Parameter
Name Description
var string
Returns
Type Description
$this

getUserId

The information about the user that created the session. It will be the email address of the user.

Returns
Type Description
string

setUserId

The information about the user that created the session. It will be the email address of the user.

Parameter
Name Description
var string
Returns
Type Description
$this

getSessionId

Unique identifier for the session.

Returns
Type Description
string

setSessionId

Unique identifier for the session.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of the event.

Returns
Type Description
int

setType

The type of the event.

Parameter
Name Description
var int
Returns
Type Description
$this

getQuery

The execution details of the query.

Returns
Type Description
Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail|null

hasQuery

setQuery

The execution details of the query.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail
Returns
Type Description
$this

getEventSucceeded

The status of the event.

Returns
Type Description
bool

setEventSucceeded

The status of the event.

Parameter
Name Description
var bool
Returns
Type Description
$this

getFastStartupEnabled

If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.

Returns
Type Description
bool

setFastStartupEnabled

If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUnassignedDuration

The idle duration of a warm pooled session before it is assigned to user.

Returns
Type Description
Google\Protobuf\Duration|null

hasUnassignedDuration

clearUnassignedDuration

setUnassignedDuration

The idle duration of a warm pooled session before it is assigned to user.

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

getDetail

Returns
Type Description
string