Constructor
new InstanceConfig(propertiesopt)
Constructs a new InstanceConfig.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstanceConfig |
<optional> |
Properties to set |
- Implements:
-
- IInstanceConfig
Members
baseConfig
InstanceConfig baseConfig.
configType
InstanceConfig configType.
displayName
InstanceConfig displayName.
etag
InstanceConfig etag.
labels
InstanceConfig labels.
leaderOptions
InstanceConfig leaderOptions.
name
InstanceConfig name.
optionalReplicas
InstanceConfig optionalReplicas.
reconciling
InstanceConfig reconciling.
replicas
InstanceConfig replicas.
state
InstanceConfig state.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
CREATING |
number |
CREATING value |
READY |
number |
READY value |
Type
Type enum.
Properties:
| Name | Type | Description |
|---|---|---|
TYPE_UNSPECIFIED |
number |
TYPE_UNSPECIFIED value |
GOOGLE_MANAGED |
number |
GOOGLE_MANAGED value |
USER_MANAGED |
number |
USER_MANAGED value |
Methods
toJSON() → {Object.<string, *>}
Converts this InstanceConfig to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.admin.instance.v1.InstanceConfig}
Creates a new InstanceConfig instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstanceConfig |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.InstanceConfig |
InstanceConfig instance |
(static) decode(reader, lengthopt) → {google.spanner.admin.instance.v1.InstanceConfig}
Decodes an InstanceConfig message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.InstanceConfig |
InstanceConfig |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.spanner.admin.instance.v1.InstanceConfig}
Decodes an InstanceConfig message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.InstanceConfig |
InstanceConfig |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified InstanceConfig message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstanceConfig |
InstanceConfig message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified InstanceConfig message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstanceConfig |
InstanceConfig message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.spanner.admin.instance.v1.InstanceConfig}
Creates an InstanceConfig message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.InstanceConfig |
InstanceConfig |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for InstanceConfig
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an InstanceConfig message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.InstanceConfig |
InstanceConfig |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an InstanceConfig message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|