Google Cloud Dataplex V1 Client - Class SessionEvent (0.14.0)

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
NameDescription
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
TypeDescription
string

setMessage

The log message.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserId

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

Returns
TypeDescription
string

setUserId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSessionId

Unique identifier for the session.

Returns
TypeDescription
string

setSessionId

Unique identifier for the session.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The type of the event.

Returns
TypeDescription
int

setType

The type of the event.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getQuery

The execution details of the query.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail|null

hasQuery

setQuery

The execution details of the query.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail
Returns
TypeDescription
$this

getEventSucceeded

The status of the event.

Returns
TypeDescription
bool

setEventSucceeded

The status of the event.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getFastStartupEnabled

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

Returns
TypeDescription
bool

setFastStartupEnabled

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUnassignedDuration

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

Returns
TypeDescription
Google\Protobuf\Duration|null

hasUnassignedDuration

clearUnassignedDuration

setUnassignedDuration

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

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getDetail

Returns
TypeDescription
string