Class protos.google.cloud.dataplex.v1.SessionEvent.QueryDetail (2.3.1)

Represents a QueryDetail.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new QueryDetail.

Parameter
NameDescription
properties IQueryDetail

Properties to set

Properties

dataProcessedBytes

public dataProcessedBytes: (number|Long|string);

QueryDetail dataProcessedBytes.

duration

public duration?: (google.protobuf.IDuration|null);

QueryDetail duration.

engine

public engine: (google.cloud.dataplex.v1.SessionEvent.QueryDetail.Engine|keyof typeof google.cloud.dataplex.v1.SessionEvent.QueryDetail.Engine);

QueryDetail engine.

queryId

public queryId: string;

QueryDetail queryId.

queryText

public queryText: string;

QueryDetail queryText.

resultSizeBytes

public resultSizeBytes: (number|Long|string);

QueryDetail resultSizeBytes.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.SessionEvent.IQueryDetail): google.cloud.dataplex.v1.SessionEvent.QueryDetail;

Creates a new QueryDetail instance using the specified properties.

Parameter
NameDescription
properties IQueryDetail

Properties to set

Returns
TypeDescription
google.cloud.dataplex.v1.SessionEvent.QueryDetail

QueryDetail instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.SessionEvent.QueryDetail;

Decodes a QueryDetail 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.QueryDetail

QueryDetail

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.SessionEvent.QueryDetail;

Decodes a QueryDetail 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.QueryDetail

QueryDetail

encode(message, writer)

public static encode(message: google.cloud.dataplex.v1.SessionEvent.IQueryDetail, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified QueryDetail message. Does not implicitly messages.

Parameters
NameDescription
message IQueryDetail

QueryDetail 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.SessionEvent.IQueryDetail, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified QueryDetail message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IQueryDetail

QueryDetail 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.QueryDetail;

Creates a QueryDetail 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.QueryDetail

QueryDetail

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for QueryDetail

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this QueryDetail to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dataplex.v1.SessionEvent.QueryDetail, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a QueryDetail message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.dataplex.v1.SessionEvent.QueryDetail

QueryDetail

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 QueryDetail 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