Class protos.google.bigtable.admin.v2.Instance (3.6.0)

Represents an Instance.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new Instance.

Parameter

Name	Description
properties	`google.bigtable.admin.v2.IInstance` Properties to set

Properties

displayName

public displayName: string;

Instance displayName.

Property Value

Type	Description
string

labels

public labels: { [k: string]: string };

Instance labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

Instance name.

Property Value

Type	Description
string

state

public state: (google.bigtable.admin.v2.Instance.State|keyof typeof google.bigtable.admin.v2.Instance.State);

Instance state.

Property Value

Type	Description
(google.bigtable.admin.v2.Instance.State\|keyof typeof google.bigtable.admin.v2.Instance.State)

type

public type: (google.bigtable.admin.v2.Instance.Type|keyof typeof google.bigtable.admin.v2.Instance.Type);

Instance type.

Property Value

Type	Description
(google.bigtable.admin.v2.Instance.Type\|keyof typeof google.bigtable.admin.v2.Instance.Type)

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IInstance): google.bigtable.admin.v2.Instance;

Creates a new Instance instance using the specified properties.

Parameter

Name	Description
properties	`google.bigtable.admin.v2.IInstance` Properties to set

Returns

Type	Description
google.bigtable.admin.v2.Instance	Instance instance

decode(reader, length)

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

Decodes an Instance message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.bigtable.admin.v2.Instance	Instance

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.bigtable.admin.v2.Instance	Instance

encode(message, writer)

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

Encodes the specified Instance message. Does not implicitly messages.

Parameters

Name	Description
message	`google.bigtable.admin.v2.IInstance` Instance 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.bigtable.admin.v2.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.bigtable.admin.v2.IInstance` Instance 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.bigtable.admin.v2.Instance;

Creates an Instance 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
google.bigtable.admin.v2.Instance	Instance

toJSON()

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

Converts this Instance to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.bigtable.admin.v2.Instance` Instance
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 an Instance 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