Class protos.google.cloud.bigquery.storage.v1.AppendRowsResponse (4.4.0)

Represents an AppendRowsResponse.

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(properties)

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

Constructs a new AppendRowsResponse.

Parameter
NameDescription
properties IAppendRowsResponse

Properties to set

Properties

appendResult

public appendResult?: (google.cloud.bigquery.storage.v1.AppendRowsResponse.IAppendResult|null);

AppendRowsResponse appendResult.

error

public error?: (google.rpc.IStatus|null);

AppendRowsResponse error.

response

public response?: ("appendResult"|"error");

AppendRowsResponse response.

rowErrors

public rowErrors: google.cloud.bigquery.storage.v1.IRowError[];

AppendRowsResponse rowErrors.

updatedSchema

public updatedSchema?: (google.cloud.bigquery.storage.v1.ITableSchema|null);

AppendRowsResponse updatedSchema.

writeStream

public writeStream: string;

AppendRowsResponse writeStream.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1.IAppendRowsResponse): google.cloud.bigquery.storage.v1.AppendRowsResponse;

Creates a new AppendRowsResponse instance using the specified properties.

Parameter
NameDescription
properties IAppendRowsResponse

Properties to set

Returns
TypeDescription
AppendRowsResponse

AppendRowsResponse instance

decode(reader, length)

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

Decodes an AppendRowsResponse message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
AppendRowsResponse

AppendRowsResponse

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AppendRowsResponse

AppendRowsResponse

encode(message, writer)

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

Encodes the specified AppendRowsResponse message. Does not implicitly messages.

Parameters
NameDescription
message IAppendRowsResponse

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

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

Parameters
NameDescription
message IAppendRowsResponse

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

Creates an AppendRowsResponse message from a plain object. Also converts values to their respective internal types.

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

Plain object

Returns
TypeDescription
AppendRowsResponse

AppendRowsResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AppendRowsResponse

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AppendRowsResponse

AppendRowsResponse

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AppendRowsResponse 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