Class protos.google.cloud.bigquery.storage.v1.CreateReadSessionRequest

Represents a CreateReadSessionRequest.

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(properties)

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

Constructs a new CreateReadSessionRequest.

Parameter
NameDescription
properties ICreateReadSessionRequest

Properties to set

Properties

maxStreamCount

public maxStreamCount: number;

CreateReadSessionRequest maxStreamCount.

parent

public parent: string;

CreateReadSessionRequest parent.

readSession

public readSession?: (google.cloud.bigquery.storage.v1.IReadSession|null);

CreateReadSessionRequest readSession.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.storage.v1.ICreateReadSessionRequest): google.cloud.bigquery.storage.v1.CreateReadSessionRequest;

Creates a new CreateReadSessionRequest instance using the specified properties.

Parameter
NameDescription
properties ICreateReadSessionRequest

Properties to set

Returns
TypeDescription
google.cloud.bigquery.storage.v1.CreateReadSessionRequest

CreateReadSessionRequest instance

decode(reader, length)

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

Decodes a CreateReadSessionRequest 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.storage.v1.CreateReadSessionRequest

CreateReadSessionRequest

decodeDelimited(reader)

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

Decodes a CreateReadSessionRequest 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.storage.v1.CreateReadSessionRequest

CreateReadSessionRequest

encode(message, writer)

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

Encodes the specified CreateReadSessionRequest message. Does not implicitly messages.

Parameters
NameDescription
message ICreateReadSessionRequest

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

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

Parameters
NameDescription
message ICreateReadSessionRequest

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

Creates a CreateReadSessionRequest 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.storage.v1.CreateReadSessionRequest

CreateReadSessionRequest

toJSON()

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

Converts this CreateReadSessionRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.bigquery.storage.v1.CreateReadSessionRequest

CreateReadSessionRequest

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