Class protos.google.cloud.bigquery.storage.v1.AppendRowsRequest (4.5.0)

Represents an AppendRowsRequest.

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.storage.v1.IAppendRowsRequest);

Constructs a new AppendRowsRequest.

Parameter
Name Description
properties IAppendRowsRequest

Properties to set

Properties

defaultMissingValueInterpretation

public defaultMissingValueInterpretation: (google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation|keyof typeof google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation);

AppendRowsRequest defaultMissingValueInterpretation.

missingValueInterpretations

public missingValueInterpretations: { [k: string]: google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation };

AppendRowsRequest missingValueInterpretations.

offset

public offset?: (google.protobuf.IInt64Value|null);

AppendRowsRequest offset.

protoRows

public protoRows?: (google.cloud.bigquery.storage.v1.AppendRowsRequest.IProtoData|null);

AppendRowsRequest protoRows.

rows

public rows?: "protoRows";

AppendRowsRequest rows.

traceId

public traceId: string;

AppendRowsRequest traceId.

writeStream

public writeStream: string;

AppendRowsRequest writeStream.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1.IAppendRowsRequest): google.cloud.bigquery.storage.v1.AppendRowsRequest;

Creates a new AppendRowsRequest instance using the specified properties.

Parameter
Name Description
properties IAppendRowsRequest

Properties to set

Returns
Type Description
AppendRowsRequest

AppendRowsRequest instance

decode(reader, length)

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

Decodes an AppendRowsRequest 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
AppendRowsRequest

AppendRowsRequest

decodeDelimited(reader)

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

Decodes an AppendRowsRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AppendRowsRequest

AppendRowsRequest

encode(message, writer)

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

Encodes the specified AppendRowsRequest message. Does not implicitly messages.

Parameters
Name Description
message IAppendRowsRequest

AppendRowsRequest 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.bigquery.storage.v1.IAppendRowsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAppendRowsRequest

AppendRowsRequest 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.bigquery.storage.v1.AppendRowsRequest;

Creates an AppendRowsRequest 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
AppendRowsRequest

AppendRowsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AppendRowsRequest

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AppendRowsRequest

AppendRowsRequest

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 an AppendRowsRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not