Constructor
new Backup(propertiesopt)
Constructs a new Backup.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.database.v1.IBackup |
<optional> |
Properties to set |
- Implements:
-
- IBackup
Members
backupSchedules
Backup backupSchedules.
createTime
Backup createTime.
database
Backup database.
databaseDialect
Backup databaseDialect.
encryptionInfo
Backup encryptionInfo.
encryptionInformation
Backup encryptionInformation.
exclusiveSizeBytes
Backup exclusiveSizeBytes.
expireTime
Backup expireTime.
freeableSizeBytes
Backup freeableSizeBytes.
incrementalBackupChainId
Backup incrementalBackupChainId.
maxExpireTime
Backup maxExpireTime.
name
Backup name.
oldestVersionTime
Backup oldestVersionTime.
referencingBackups
Backup referencingBackups.
referencingDatabases
Backup referencingDatabases.
sizeBytes
Backup sizeBytes.
state
Backup state.
versionTime
Backup versionTime.
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 Backup to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.spanner.admin.database.v1.Backup}
Creates a new Backup instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.spanner.admin.database.v1.IBackup |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.spanner.admin.database.v1.Backup |
Backup instance |
(static) decode(reader, lengthopt) → {google.spanner.admin.database.v1.Backup}
Decodes a Backup 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.database.v1.Backup |
Backup |
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.database.v1.Backup}
Decodes a Backup 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.database.v1.Backup |
Backup |
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 Backup message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.database.v1.IBackup |
Backup 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 Backup message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.database.v1.IBackup |
Backup 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.database.v1.Backup}
Creates a Backup 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.database.v1.Backup |
Backup |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Backup
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 a Backup message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.spanner.admin.database.v1.Backup |
Backup |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Backup message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|