Class protos.google.bigtable.admin.v2.CreateTableRequest (5.0.0)

Represents a CreateTableRequest.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.admin.v2.ICreateTableRequest);

Constructs a new CreateTableRequest.

Parameter
NameDescription
properties ICreateTableRequest

Properties to set

Properties

initialSplits

public initialSplits: google.bigtable.admin.v2.CreateTableRequest.ISplit[];

CreateTableRequest initialSplits.

parent

public parent: string;

CreateTableRequest parent.

table

public table?: (google.bigtable.admin.v2.ITable|null);

CreateTableRequest table.

tableId

public tableId: string;

CreateTableRequest tableId.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.ICreateTableRequest): google.bigtable.admin.v2.CreateTableRequest;

Creates a new CreateTableRequest instance using the specified properties.

Parameter
NameDescription
properties ICreateTableRequest

Properties to set

Returns
TypeDescription
CreateTableRequest

CreateTableRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.bigtable.admin.v2.CreateTableRequest;

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

CreateTableRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.admin.v2.CreateTableRequest;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CreateTableRequest

CreateTableRequest

encode(message, writer)

public static encode(message: google.bigtable.admin.v2.ICreateTableRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateTableRequest message. Does not implicitly messages.

Parameters
NameDescription
message ICreateTableRequest

CreateTableRequest 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.bigtable.admin.v2.ICreateTableRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICreateTableRequest

CreateTableRequest 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.bigtable.admin.v2.CreateTableRequest;

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

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

Plain object

Returns
TypeDescription
CreateTableRequest

CreateTableRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreateTableRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.bigtable.admin.v2.CreateTableRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message CreateTableRequest

CreateTableRequest

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