Class protos.google.cloud.bigquery.datatransfer.v1.TransferMessage (3.2.2)

Represents a TransferMessage.

Package

@google-cloud/bigquery-data-transfer

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.datatransfer.v1.ITransferMessage);

Constructs a new TransferMessage.

Parameter
NameDescription
properties ITransferMessage

Properties to set

Properties

messageText

public messageText: string;

TransferMessage messageText.

messageTime

public messageTime?: (google.protobuf.ITimestamp|null);

TransferMessage messageTime.

severity

public severity: (google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity);

TransferMessage severity.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.datatransfer.v1.ITransferMessage): google.cloud.bigquery.datatransfer.v1.TransferMessage;

Creates a new TransferMessage instance using the specified properties.

Parameter
NameDescription
properties ITransferMessage

Properties to set

Returns
TypeDescription
google.cloud.bigquery.datatransfer.v1.TransferMessage

TransferMessage instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v1.TransferMessage;

Decodes a TransferMessage 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.bigquery.datatransfer.v1.TransferMessage

TransferMessage

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.TransferMessage;

Decodes a TransferMessage 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.bigquery.datatransfer.v1.TransferMessage

TransferMessage

encode(message, writer)

public static encode(message: google.cloud.bigquery.datatransfer.v1.ITransferMessage, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransferMessage message. Does not implicitly messages.

Parameters
NameDescription
message ITransferMessage

TransferMessage 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.bigquery.datatransfer.v1.ITransferMessage, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITransferMessage

TransferMessage 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.bigquery.datatransfer.v1.TransferMessage;

Creates a TransferMessage 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.bigquery.datatransfer.v1.TransferMessage

TransferMessage

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TransferMessage

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 TransferMessage to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.bigquery.datatransfer.v1.TransferMessage

TransferMessage

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