Represents a Backup.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?: google.spanner.admin.database.v1.IBackup);Constructs a new Backup.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackup
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Backup createTime.
database
public database: string;Backup database.
databaseDialect
public databaseDialect: (google.spanner.admin.database.v1.DatabaseDialect|keyof typeof google.spanner.admin.database.v1.DatabaseDialect);Backup databaseDialect.
encryptionInfo
public encryptionInfo?: (google.spanner.admin.database.v1.IEncryptionInfo|null);Backup encryptionInfo.
expireTime
public expireTime?: (google.protobuf.ITimestamp|null);Backup expireTime.
maxExpireTime
public maxExpireTime?: (google.protobuf.ITimestamp|null);Backup maxExpireTime.
name
public name: string;Backup name.
referencingBackups
public referencingBackups: string[];Backup referencingBackups.
referencingDatabases
public referencingDatabases: string[];Backup referencingDatabases.
sizeBytes
public sizeBytes: (number|Long|string);Backup sizeBytes.
state
public state: (google.spanner.admin.database.v1.Backup.State|keyof typeof google.spanner.admin.database.v1.Backup.State);Backup state.
versionTime
public versionTime?: (google.protobuf.ITimestamp|null);Backup versionTime.
Methods
create(properties)
public static create(properties?: google.spanner.admin.database.v1.IBackup): google.spanner.admin.database.v1.Backup;Creates a new Backup instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackup
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Backup | Backup instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.admin.database.v1.Backup;Decodes a Backup 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 |
Backup | Backup |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.database.v1.Backup;Decodes a Backup message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Backup | Backup |
encode(message, writer)
public static encode(message: google.spanner.admin.database.v1.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Backup message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackup
Backup 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.database.v1.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Backup message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackup
Backup 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.database.v1.Backup;Creates a Backup 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 |
Backup | Backup |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Backup
| 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 Backup to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.spanner.admin.database.v1.Backup, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Backup message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Backup
Backup |
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 a Backup message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|