Represents a BackupVault.
Package
@google-cloud/backupdrConstructors
(constructor)(properties)
constructor(properties?: google.cloud.backupdr.v1.IBackupVault);Constructs a new BackupVault.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupVault
Properties to set |
Properties
accessRestriction
public accessRestriction: (google.cloud.backupdr.v1.BackupVault.AccessRestriction|keyof typeof google.cloud.backupdr.v1.BackupVault.AccessRestriction);BackupVault accessRestriction.
annotations
public annotations: { [k: string]: string };BackupVault annotations.
backupCount
public backupCount: (number|Long|string);BackupVault backupCount.
backupMinimumEnforcedRetentionDuration
public backupMinimumEnforcedRetentionDuration?: (google.protobuf.IDuration|null);BackupVault backupMinimumEnforcedRetentionDuration.
backupRetentionInheritance
public backupRetentionInheritance?: (google.cloud.backupdr.v1.BackupVault.BackupRetentionInheritance|keyof typeof google.cloud.backupdr.v1.BackupVault.BackupRetentionInheritance|null);BackupVault backupRetentionInheritance.
createTime
public createTime?: (google.protobuf.ITimestamp|null);BackupVault createTime.
deletable
public deletable?: (boolean|null);BackupVault deletable.
description
public description?: (string|null);BackupVault description.
effectiveTime
public effectiveTime?: (google.protobuf.ITimestamp|null);BackupVault effectiveTime.
encryptionConfig
public encryptionConfig?: (google.cloud.backupdr.v1.BackupVault.IEncryptionConfig|null);BackupVault encryptionConfig.
etag
public etag?: (string|null);BackupVault etag.
labels
public labels: { [k: string]: string };BackupVault labels.
name
public name: string;BackupVault name.
serviceAccount
public serviceAccount: string;BackupVault serviceAccount.
state
public state: (google.cloud.backupdr.v1.BackupVault.State|keyof typeof google.cloud.backupdr.v1.BackupVault.State);BackupVault state.
totalStoredBytes
public totalStoredBytes: (number|Long|string);BackupVault totalStoredBytes.
uid
public uid: string;BackupVault uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);BackupVault updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.backupdr.v1.IBackupVault): google.cloud.backupdr.v1.BackupVault;Creates a new BackupVault instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupVault
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackupVault |
BackupVault instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.backupdr.v1.BackupVault;Decodes a BackupVault 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 |
BackupVault |
BackupVault |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.backupdr.v1.BackupVault;Decodes a BackupVault message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackupVault |
BackupVault |
encode(message, writer)
public static encode(message: google.cloud.backupdr.v1.IBackupVault, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupVault message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupVault
BackupVault 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.backupdr.v1.IBackupVault, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupVault message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupVault
BackupVault 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.backupdr.v1.BackupVault;Creates a BackupVault 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 |
BackupVault |
BackupVault |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackupVault
| 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 BackupVault to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.backupdr.v1.BackupVault, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackupVault message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackupVault
BackupVault |
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 BackupVault message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|