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

Represents an InstanceConfig.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new InstanceConfig.

Parameter
TypeNameDescription
IInstanceConfigproperties

Properties to set

Properties

displayName

public displayName: string;

InstanceConfig displayName.

Property Value
TypeDescription
string

name

public name: string;

InstanceConfig name.

Property Value
TypeDescription
string

replicas

public replicas: google.spanner.admin.instance.v1.IReplicaInfo[];

InstanceConfig replicas.

Property Value
TypeDescription
google.spanner.admin.instance.v1.IReplicaInfo[]

Methods

create(properties)

public static create(properties?: google.spanner.admin.instance.v1.IInstanceConfig): google.spanner.admin.instance.v1.InstanceConfig;

Creates a new InstanceConfig instance using the specified properties.

Parameter
TypeNameDescription
IInstanceConfigproperties

Properties to set

Returns
TypeDescription
google.spanner.admin.instance.v1.InstanceConfig

InstanceConfig instance

decode(reader, length)

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

Decodes an InstanceConfig message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.spanner.admin.instance.v1.InstanceConfig

InstanceConfig

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.spanner.admin.instance.v1.InstanceConfig

InstanceConfig

encode(message, writer)

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

Encodes the specified InstanceConfig message. Does not implicitly messages.

Parameters
TypeNameDescription
IInstanceConfigmessage

InstanceConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IInstanceConfigmessage

InstanceConfig message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
google.spanner.admin.instance.v1.InstanceConfig

InstanceConfig

toJSON()

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

Converts this InstanceConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.spanner.admin.instance.v1.InstanceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
TypeNameDescription
google.spanner.admin.instance.v1.InstanceConfigmessage

InstanceConfig

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an InstanceConfig message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not