Represents an InstanceConfig.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?: google.spanner.admin.instance.v1.IInstanceConfig);Constructs a new InstanceConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstanceConfig
Properties to set |
Properties
baseConfig
public baseConfig: string;InstanceConfig baseConfig.
configType
public configType: (google.spanner.admin.instance.v1.InstanceConfig.Type|keyof typeof google.spanner.admin.instance.v1.InstanceConfig.Type);InstanceConfig configType.
displayName
public displayName: string;InstanceConfig displayName.
etag
public etag: string;InstanceConfig etag.
labels
public labels: { [k: string]: string };InstanceConfig labels.
leaderOptions
public leaderOptions: string[];InstanceConfig leaderOptions.
name
public name: string;InstanceConfig name.
optionalReplicas
public optionalReplicas: google.spanner.admin.instance.v1.IReplicaInfo[];InstanceConfig optionalReplicas.
reconciling
public reconciling: boolean;InstanceConfig reconciling.
replicas
public replicas: google.spanner.admin.instance.v1.IReplicaInfo[];InstanceConfig replicas.
state
public state: (google.spanner.admin.instance.v1.InstanceConfig.State|keyof typeof google.spanner.admin.instance.v1.InstanceConfig.State);InstanceConfig state.
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 | |
|---|---|
| Name | Description |
properties |
IInstanceConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IInstanceConfig
InstanceConfig 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.IInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified InstanceConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstanceConfig
InstanceConfig 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.InstanceConfig;Creates an InstanceConfig 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 |
InstanceConfig | InstanceConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for InstanceConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this InstanceConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
InstanceConfig
InstanceConfig |
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 InstanceConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|