Represents a SessionEvent.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.ISessionEvent);Constructs a new SessionEvent.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISessionEvent
Properties to set |
Properties
detail
public detail?: "query";SessionEvent detail.
eventSucceeded
public eventSucceeded: boolean;SessionEvent eventSucceeded.
fastStartupEnabled
public fastStartupEnabled: boolean;SessionEvent fastStartupEnabled.
message
public message: string;SessionEvent message.
query
public query?: (google.cloud.dataplex.v1.SessionEvent.IQueryDetail|null);SessionEvent query.
sessionId
public sessionId: string;SessionEvent sessionId.
type
public type: (google.cloud.dataplex.v1.SessionEvent.EventType|keyof typeof google.cloud.dataplex.v1.SessionEvent.EventType);SessionEvent type.
unassignedDuration
public unassignedDuration?: (google.protobuf.IDuration|null);SessionEvent unassignedDuration.
userId
public userId: string;SessionEvent userId.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.ISessionEvent): google.cloud.dataplex.v1.SessionEvent;Creates a new SessionEvent instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISessionEvent
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SessionEvent |
SessionEvent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.SessionEvent;Decodes a SessionEvent message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
SessionEvent |
SessionEvent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.SessionEvent;Decodes a SessionEvent message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SessionEvent |
SessionEvent |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.ISessionEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SessionEvent message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISessionEvent
SessionEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dataplex.v1.ISessionEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SessionEvent message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISessionEvent
SessionEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dataplex.v1.SessionEvent;Creates a SessionEvent message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
SessionEvent |
SessionEvent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SessionEvent
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this SessionEvent to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.SessionEvent, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SessionEvent message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SessionEvent
SessionEvent |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a SessionEvent message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|