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

Represents a ReplicaInfo.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

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

Constructs a new ReplicaInfo.

Parameter

Type	Name	Description
IReplicaInfo	properties	Properties to set

Properties

defaultLeaderLocation

public defaultLeaderLocation: boolean;

ReplicaInfo defaultLeaderLocation.

Property Value

Type	Description
boolean

location

public location: string;

ReplicaInfo location.

Property Value

Type	Description
string

type

public type: (google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType|keyof typeof google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType);

ReplicaInfo type.

Property Value

Type	Description
(google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType\|keyof typeof google.spanner.admin.instance.v1.ReplicaInfo.ReplicaType)

Methods

create(properties)

public static create(properties?: google.spanner.admin.instance.v1.IReplicaInfo): google.spanner.admin.instance.v1.ReplicaInfo;

Creates a new ReplicaInfo instance using the specified properties.

Parameter

Type	Name	Description
IReplicaInfo	properties	Properties to set

Returns

Type	Description
google.spanner.admin.instance.v1.ReplicaInfo	ReplicaInfo instance

decode(reader, length)

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

Decodes a ReplicaInfo 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.ReplicaInfo	ReplicaInfo

decodeDelimited(reader)

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

Decodes a ReplicaInfo 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.ReplicaInfo	ReplicaInfo

encode(message, writer)

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

Encodes the specified ReplicaInfo message. Does not implicitly messages.

Parameters

Type	Name	Description
IReplicaInfo	message	ReplicaInfo 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.IReplicaInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IReplicaInfo	message	ReplicaInfo 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.ReplicaInfo;

Creates a ReplicaInfo 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.ReplicaInfo	ReplicaInfo

toJSON()

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

Converts this ReplicaInfo to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.spanner.admin.instance.v1.ReplicaInfo	message	ReplicaInfo
$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 a ReplicaInfo 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