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
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. |
↳ 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. |
getMessage
The log message.
Generated from protobuf field string message = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
The log message.
Generated from protobuf field string message = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserId
The information about the user that created the session.
Generated from protobuf field string user_id = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setUserId
The information about the user that created the session.
Generated from protobuf field string user_id = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSessionId
Unique identifier for the session.
Generated from protobuf field string session_id = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setSessionId
Unique identifier for the session.
Generated from protobuf field string session_id = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of the event.
Generated from protobuf field .google.cloud.dataplex.v1.SessionEvent.EventType type = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of the event.
Generated from protobuf field .google.cloud.dataplex.v1.SessionEvent.EventType type = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuery
The execution details of the query.
Generated from protobuf field .google.cloud.dataplex.v1.SessionEvent.QueryDetail query = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail|null | |
hasQuery
setQuery
The execution details of the query.
Generated from protobuf field .google.cloud.dataplex.v1.SessionEvent.QueryDetail query = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\SessionEvent\QueryDetail
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetail
| Returns | |
|---|---|
| Type | Description |
string | |