Represents a Backup.
Package
@google-cloud/alloydbConstructors
(constructor)(properties)
constructor(properties?: google.cloud.alloydb.v1beta.IBackup);Constructs a new Backup.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackup
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };Backup annotations.
clusterName
public clusterName: string;Backup clusterName.
clusterUid
public clusterUid: string;Backup clusterUid.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Backup createTime.
databaseVersion
public databaseVersion: (google.cloud.alloydb.v1beta.DatabaseVersion|keyof typeof google.cloud.alloydb.v1beta.DatabaseVersion);Backup databaseVersion.
deleteTime
public deleteTime?: (google.protobuf.ITimestamp|null);Backup deleteTime.
description
public description: string;Backup description.
displayName
public displayName: string;Backup displayName.
encryptionConfig
public encryptionConfig?: (google.cloud.alloydb.v1beta.IEncryptionConfig|null);Backup encryptionConfig.
encryptionInfo
public encryptionInfo?: (google.cloud.alloydb.v1beta.IEncryptionInfo|null);Backup encryptionInfo.
etag
public etag: string;Backup etag.
expiryQuantity
public expiryQuantity?: (google.cloud.alloydb.v1beta.Backup.IQuantityBasedExpiry|null);Backup expiryQuantity.
expiryTime
public expiryTime?: (google.protobuf.ITimestamp|null);Backup expiryTime.
labels
public labels: { [k: string]: string };Backup labels.
name
public name: string;Backup name.
reconciling
public reconciling: boolean;Backup reconciling.
satisfiesPzs
public satisfiesPzs: boolean;Backup satisfiesPzs.
sizeBytes
public sizeBytes: (number|Long|string);Backup sizeBytes.
state
public state: (google.cloud.alloydb.v1beta.Backup.State|keyof typeof google.cloud.alloydb.v1beta.Backup.State);Backup state.
tags
public tags: { [k: string]: string };Backup tags.
type
public type: (google.cloud.alloydb.v1beta.Backup.Type|keyof typeof google.cloud.alloydb.v1beta.Backup.Type);Backup type.
uid
public uid: string;Backup uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Backup updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.alloydb.v1beta.IBackup): google.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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.cloud.alloydb.v1beta.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) |
|