Constructor
new Instance(propertiesopt)
Constructs a new Instance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstance |
<optional> |
Properties to set |
- Implements:
-
- IInstance
Members
autoscalingConfig
Instance autoscalingConfig.
config
Instance config.
createTime
Instance createTime.
defaultBackupScheduleType
Instance defaultBackupScheduleType.
displayName
Instance displayName.
edition
Instance edition.
endpointUris
Instance endpointUris.
labels
Instance labels.
name
Instance name.
nodeCount
Instance nodeCount.
processingUnits
Instance processingUnits.
replicaComputeCapacity
Instance replicaComputeCapacity.
state
Instance state.
updateTime
Instance updateTime.
DefaultBackupScheduleType
DefaultBackupScheduleType enum.
Properties:
| Name | Type | Description |
|---|---|---|
DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED |
number |
DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED value |
NONE |
number |
NONE value |
AUTOMATIC |
number |
AUTOMATIC value |
Edition
Edition enum.
Properties:
| Name | Type | Description |
|---|---|---|
EDITION_UNSPECIFIED |
number |
EDITION_UNSPECIFIED value |
STANDARD |
number |
STANDARD value |
ENTERPRISE |
number |
ENTERPRISE value |
ENTERPRISE_PLUS |
number |
ENTERPRISE_PLUS value |
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
CREATING |
number |
CREATING value |
READY |
number |
READY value |
Methods
toJSON() → {Object.<string, *>}
Converts this Instance to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.admin.instance.v1.Instance}
Creates a new Instance instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstance |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.Instance |
Instance instance |
(static) decode(reader, lengthopt) → {google.spanner.admin.instance.v1.Instance}
Decodes an Instance 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.Instance |
Instance |
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.Instance}
Decodes an Instance 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.Instance |
Instance |
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 Instance message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstance |
Instance 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 Instance message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstance |
Instance 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.Instance}
Creates an Instance 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.Instance |
Instance |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Instance
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 Instance message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.Instance |
Instance |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Instance message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|