Represents a Backup.
Package
@google-cloud/spanner!Constructors
(constructor)(properties)
constructor(properties?: google.spanner.admin.database.v1.IBackup);Constructs a new Backup.
| Type | Name | Description |
|---|---|---|
| IBackup | properties |
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Backup createTime.
| Type | Description |
|---|---|
| (google.protobuf.ITimestamp|null) |
database
public database: string;Backup database.
| Type | Description |
|---|---|
| string |
encryptionInfo
public encryptionInfo?: (google.spanner.admin.database.v1.IEncryptionInfo|null);Backup encryptionInfo.
| Type | Description |
|---|---|
| (google.spanner.admin.database.v1.IEncryptionInfo|null) |
expireTime
public expireTime?: (google.protobuf.ITimestamp|null);Backup expireTime.
| Type | Description |
|---|---|
| (google.protobuf.ITimestamp|null) |
name
public name: string;Backup name.
| Type | Description |
|---|---|
| string |
referencingDatabases
public referencingDatabases: string[];Backup referencingDatabases.
| Type | Description |
|---|---|
| string[] |
sizeBytes
public sizeBytes: (number|Long|string);Backup sizeBytes.
| Type | Description |
|---|---|
| (number|Long|string) |
state
public state: (google.spanner.admin.database.v1.Backup.State|keyof typeof google.spanner.admin.database.v1.Backup.State);Backup state.
| Type | Description |
|---|---|
| (google.spanner.admin.database.v1.Backup.State|keyof typeof google.spanner.admin.database.v1.Backup.State) |
versionTime
public versionTime?: (google.protobuf.ITimestamp|null);Backup versionTime.
| Type | Description |
|---|---|
| (google.protobuf.ITimestamp|null) |
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.
| Type | Name | Description |
|---|---|---|
| IBackup | properties |
Properties to set |
| Type | Description |
|---|---|
| google.spanner.admin.database.v1.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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.spanner.admin.database.v1.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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.spanner.admin.database.v1.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.
| Type | Name | Description |
|---|---|---|
| IBackup | message |
Backup message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| IBackup | message |
Backup message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.spanner.admin.database.v1.Backup | Backup |
toJSON()
public toJSON(): { [k: string]: any };Converts this Backup to JSON.
| 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.
| Type | Name | Description |
|---|---|---|
| google.spanner.admin.database.v1.Backup | message |
Backup |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Backup message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|