Represents a BackupConfig.
Package
@google-cloud/gke-backupConstructors
(constructor)(properties)
constructor(properties?: google.cloud.gkebackup.v1.BackupPlan.IBackupConfig);Constructs a new BackupConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupConfig
Properties to set |
Properties
allNamespaces
public allNamespaces?: (boolean|null);BackupConfig allNamespaces.
backupScope
public backupScope?: ("allNamespaces"|"selectedNamespaces"|"selectedApplications");BackupConfig backupScope.
encryptionKey
public encryptionKey?: (google.cloud.gkebackup.v1.IEncryptionKey|null);BackupConfig encryptionKey.
includeSecrets
public includeSecrets: boolean;BackupConfig includeSecrets.
includeVolumeData
public includeVolumeData: boolean;BackupConfig includeVolumeData.
selectedApplications
public selectedApplications?: (google.cloud.gkebackup.v1.INamespacedNames|null);BackupConfig selectedApplications.
selectedNamespaces
public selectedNamespaces?: (google.cloud.gkebackup.v1.INamespaces|null);BackupConfig selectedNamespaces.
Methods
create(properties)
public static create(properties?: google.cloud.gkebackup.v1.BackupPlan.IBackupConfig): google.cloud.gkebackup.v1.BackupPlan.BackupConfig;Creates a new BackupConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackupConfig | BackupConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkebackup.v1.BackupPlan.BackupConfig;Decodes a BackupConfig 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 |
BackupConfig | BackupConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkebackup.v1.BackupPlan.BackupConfig;Decodes a BackupConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackupConfig | BackupConfig |
encode(message, writer)
public static encode(message: google.cloud.gkebackup.v1.BackupPlan.IBackupConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupConfig
BackupConfig 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.gkebackup.v1.BackupPlan.IBackupConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupConfig
BackupConfig 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.gkebackup.v1.BackupPlan.BackupConfig;Creates a BackupConfig 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 |
BackupConfig | BackupConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackupConfig
| 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 BackupConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.gkebackup.v1.BackupPlan.BackupConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackupConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackupConfig
BackupConfig |
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 BackupConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|