Represents a CreateReadSessionRequest.
Package
@google-cloud/bigquery-storageConstructors
(constructor)(properties)
constructor(properties?: google.cloud.bigquery.storage.v1beta1.ICreateReadSessionRequest);
Constructs a new CreateReadSessionRequest.
Parameter | |
---|---|
Name | Description |
properties |
ICreateReadSessionRequest
Properties to set |
Properties
format
public format: (google.cloud.bigquery.storage.v1beta1.DataFormat|keyof typeof google.cloud.bigquery.storage.v1beta1.DataFormat);
CreateReadSessionRequest format.
parent
public parent: string;
CreateReadSessionRequest parent.
readOptions
public readOptions?: (google.cloud.bigquery.storage.v1beta1.ITableReadOptions|null);
CreateReadSessionRequest readOptions.
requestedStreams
public requestedStreams: number;
CreateReadSessionRequest requestedStreams.
shardingStrategy
public shardingStrategy: (google.cloud.bigquery.storage.v1beta1.ShardingStrategy|keyof typeof google.cloud.bigquery.storage.v1beta1.ShardingStrategy);
CreateReadSessionRequest shardingStrategy.
tableModifiers
public tableModifiers?: (google.cloud.bigquery.storage.v1beta1.ITableModifiers|null);
CreateReadSessionRequest tableModifiers.
tableReference
public tableReference?: (google.cloud.bigquery.storage.v1beta1.ITableReference|null);
CreateReadSessionRequest tableReference.
Methods
create(properties)
public static create(properties?: google.cloud.bigquery.storage.v1beta1.ICreateReadSessionRequest): google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest;
Creates a new CreateReadSessionRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ICreateReadSessionRequest
Properties to set |
Returns | |
---|---|
Type | Description |
CreateReadSessionRequest |
CreateReadSessionRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest;
Decodes a CreateReadSessionRequest 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 |
CreateReadSessionRequest |
CreateReadSessionRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest;
Decodes a CreateReadSessionRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
CreateReadSessionRequest |
CreateReadSessionRequest |
encode(message, writer)
public static encode(message: google.cloud.bigquery.storage.v1beta1.ICreateReadSessionRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CreateReadSessionRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICreateReadSessionRequest
CreateReadSessionRequest 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.v1beta1.ICreateReadSessionRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CreateReadSessionRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICreateReadSessionRequest
CreateReadSessionRequest 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.v1beta1.CreateReadSessionRequest;
Creates a CreateReadSessionRequest 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 |
CreateReadSessionRequest |
CreateReadSessionRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for CreateReadSessionRequest
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 CreateReadSessionRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a CreateReadSessionRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
CreateReadSessionRequest
CreateReadSessionRequest |
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 CreateReadSessionRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|