Class protos.google.cloud.bigquery.storage.v1.WriteStream (4.8.0)

Represents a WriteStream.

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(properties)

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

Constructs a new WriteStream.

Parameter
Name Description
properties IWriteStream

Properties to set

Properties

commitTime

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

WriteStream commitTime.

createTime

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

WriteStream createTime.

location

public location: string;

WriteStream location.

name

public name: string;

WriteStream name.

tableSchema

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

WriteStream tableSchema.

type

public type: (google.cloud.bigquery.storage.v1.WriteStream.Type|keyof typeof google.cloud.bigquery.storage.v1.WriteStream.Type);

WriteStream type.

writeMode

public writeMode: (google.cloud.bigquery.storage.v1.WriteStream.WriteMode|keyof typeof google.cloud.bigquery.storage.v1.WriteStream.WriteMode);

WriteStream writeMode.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1.IWriteStream): google.cloud.bigquery.storage.v1.WriteStream;

Creates a new WriteStream instance using the specified properties.

Parameter
Name Description
properties IWriteStream

Properties to set

Returns
Type Description
WriteStream

WriteStream instance

decode(reader, length)

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

Decodes a WriteStream 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
WriteStream

WriteStream

decodeDelimited(reader)

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

Decodes a WriteStream message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
WriteStream

WriteStream

encode(message, writer)

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

Encodes the specified WriteStream message. Does not implicitly messages.

Parameters
Name Description
message IWriteStream

WriteStream 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.IWriteStream, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IWriteStream

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

Creates a WriteStream 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
WriteStream

WriteStream

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for WriteStream

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message WriteStream

WriteStream

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 a WriteStream 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