Constructor
new InstancePartition(propertiesopt)
Constructs a new InstancePartition.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstancePartition |
<optional> |
Properties to set |
- Implements:
-
- IInstancePartition
Members
computeCapacity
InstancePartition computeCapacity.
config
InstancePartition config.
createTime
InstancePartition createTime.
displayName
InstancePartition displayName.
etag
InstancePartition etag.
name
InstancePartition name.
nodeCount
InstancePartition nodeCount.
processingUnits
InstancePartition processingUnits.
referencingBackups
InstancePartition referencingBackups.
referencingDatabases
InstancePartition referencingDatabases.
state
InstancePartition state.
updateTime
InstancePartition updateTime.
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 InstancePartition to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.admin.instance.v1.InstancePartition}
Creates a new InstancePartition instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.instance.v1.IInstancePartition |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.instance.v1.InstancePartition |
InstancePartition instance |
(static) decode(reader, lengthopt) → {google.spanner.admin.instance.v1.InstancePartition}
Decodes an InstancePartition 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.InstancePartition |
InstancePartition |
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.InstancePartition}
Decodes an InstancePartition 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.InstancePartition |
InstancePartition |
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 InstancePartition message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstancePartition |
InstancePartition 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 InstancePartition message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.IInstancePartition |
InstancePartition 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.InstancePartition}
Creates an InstancePartition 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.InstancePartition |
InstancePartition |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for InstancePartition
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 InstancePartition message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.instance.v1.InstancePartition |
InstancePartition |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an InstancePartition message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|