Class protos.google.cloud.dataplex.v1.SessionEvent (1.0.0)

Represents a SessionEvent.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.ISessionEvent);

Constructs a new SessionEvent.

Parameter
NameDescription
properties ISessionEvent

Properties to set

Properties

detail

public detail?: "query";

SessionEvent detail.

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.

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
NameDescription
properties ISessionEvent

Properties to set

Returns
TypeDescription
google.cloud.dataplex.v1.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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dataplex.v1.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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dataplex.v1.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
NameDescription
message ISessionEvent

SessionEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
message ISessionEvent

SessionEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.dataplex.v1.SessionEvent

SessionEvent

toJSON()

public toJSON(): { [k: string]: any };

Converts this SessionEvent to JSON.

Returns
TypeDescription
{ [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
NameDescription
message google.cloud.dataplex.v1.SessionEvent

SessionEvent

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SessionEvent message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not