Represents an Instance.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?: google.spanner.admin.instance.v1.IInstance);Constructs a new Instance.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstance
Properties to set |
Properties
config
public config: string;Instance config.
displayName
public displayName: string;Instance displayName.
endpointUris
public endpointUris: string[];Instance endpointUris.
labels
public labels: { [k: string]: string };Instance labels.
name
public name: string;Instance name.
nodeCount
public nodeCount: number;Instance nodeCount.
processingUnits
public processingUnits: number;Instance processingUnits.
state
public state: (google.spanner.admin.instance.v1.Instance.State|keyof typeof google.spanner.admin.instance.v1.Instance.State);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 | |
|---|---|
| Name | Description |
properties |
IInstance
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
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 | |
|---|---|
| Name | Description |
message |
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.spanner.admin.instance.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instance message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
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.spanner.admin.instance.v1.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.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 | |
|---|---|
| Name | Description |
message |
google.spanner.admin.instance.v1.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) |
|