Class protos.google.spanner.admin.instance.v1.Instance

Represents an Instance.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.admin.instance.v1.IInstance);

Constructs a new Instance.

Parameter
Type Name Description
IInstance properties

Properties to set

Properties

config

public config: string;

Instance config.

Property Value
Type Description
string

displayName

public displayName: string;

Instance displayName.

Property Value
Type Description
string

endpointUris

public endpointUris: string[];

Instance endpointUris.

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

nodeCount

public nodeCount: number;

Instance nodeCount.

Property Value
Type Description
number

processingUnits

public processingUnits: number;

Instance processingUnits.

Property Value
Type Description
number

state

public state: (google.spanner.admin.instance.v1.Instance.State|keyof typeof google.spanner.admin.instance.v1.Instance.State);

Instance state.

Property Value
Type Description
(google.spanner.admin.instance.v1.Instance.State|keyof typeof google.spanner.admin.instance.v1.Instance.State)

Methods

create(properties)

public static create(properties?: google.spanner.admin.instance.v1.IInstance): google.spanner.admin.instance.v1.Instance;

Creates a new Instance instance using the specified properties.

Parameter
Type Name Description
IInstance properties

Properties to set
Returns
Type Description
google.spanner.admin.instance.v1.Instance

Instance instance

decode(reader, length)

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

Decodes an Instance message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.spanner.admin.instance.v1.Instance

Instance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.instance.v1.Instance;

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.spanner.admin.instance.v1.Instance

Instance

encode(message, writer)

public static encode(message: google.spanner.admin.instance.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Instance message. Does not implicitly messages.

Parameters
Type Name Description
IInstance message

Instance message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.spanner.admin.instance.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IInstance message

Instance message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.spanner.admin.instance.v1.Instance;

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.spanner.admin.instance.v1.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.spanner.admin.instance.v1.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Type Name Description
google.spanner.admin.instance.v1.Instance message

Instance
$protobuf.IConversionOptions options

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
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not