Class BackupPlan.BackupConfig.Builder (0.11.0)

public static final class BackupPlan.BackupConfig.Builder extends GeneratedMessageV3.Builder<BackupPlan.BackupConfig.Builder> implements BackupPlan.BackupConfigOrBuilder

BackupConfig defines the configuration of Backups created via this BackupPlan.

Protobuf type google.cloud.gkebackup.v1.BackupPlan.BackupConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.BackupConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

build()

public BackupPlan.BackupConfig build()
Returns
TypeDescription
BackupPlan.BackupConfig

buildPartial()

public BackupPlan.BackupConfig buildPartial()
Returns
TypeDescription
BackupPlan.BackupConfig

clear()

public BackupPlan.BackupConfig.Builder clear()
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

clearAllNamespaces()

public BackupPlan.BackupConfig.Builder clearAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

clearBackupScope()

public BackupPlan.BackupConfig.Builder clearBackupScope()
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

clearEncryptionKey()

public BackupPlan.BackupConfig.Builder clearEncryptionKey()

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public BackupPlan.BackupConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

clearIncludeSecrets()

public BackupPlan.BackupConfig.Builder clearIncludeSecrets()

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

bool include_secrets = 5;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

clearIncludeVolumeData()

public BackupPlan.BackupConfig.Builder clearIncludeVolumeData()

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

bool include_volume_data = 4;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackupPlan.BackupConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

clearSelectedApplications()

public BackupPlan.BackupConfig.Builder clearSelectedApplications()

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

clearSelectedNamespaces()

public BackupPlan.BackupConfig.Builder clearSelectedNamespaces()

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

clone()

public BackupPlan.BackupConfig.Builder clone()
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

getAllNamespaces()

public boolean getAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
TypeDescription
boolean

The allNamespaces.

getBackupScopeCase()

public BackupPlan.BackupConfig.BackupScopeCase getBackupScopeCase()
Returns
TypeDescription
BackupPlan.BackupConfig.BackupScopeCase

getDefaultInstanceForType()

public BackupPlan.BackupConfig getDefaultInstanceForType()
Returns
TypeDescription
BackupPlan.BackupConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEncryptionKey()

public EncryptionKey getEncryptionKey()

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Returns
TypeDescription
EncryptionKey

The encryptionKey.

getEncryptionKeyBuilder()

public EncryptionKey.Builder getEncryptionKeyBuilder()

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Returns
TypeDescription
EncryptionKey.Builder

getEncryptionKeyOrBuilder()

public EncryptionKeyOrBuilder getEncryptionKeyOrBuilder()

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Returns
TypeDescription
EncryptionKeyOrBuilder

getIncludeSecrets()

public boolean getIncludeSecrets()

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

bool include_secrets = 5;

Returns
TypeDescription
boolean

The includeSecrets.

getIncludeVolumeData()

public boolean getIncludeVolumeData()

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

bool include_volume_data = 4;

Returns
TypeDescription
boolean

The includeVolumeData.

getSelectedApplications()

public NamespacedNames getSelectedApplications()

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Returns
TypeDescription
NamespacedNames

The selectedApplications.

getSelectedApplicationsBuilder()

public NamespacedNames.Builder getSelectedApplicationsBuilder()

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Returns
TypeDescription
NamespacedNames.Builder

getSelectedApplicationsOrBuilder()

public NamespacedNamesOrBuilder getSelectedApplicationsOrBuilder()

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Returns
TypeDescription
NamespacedNamesOrBuilder

getSelectedNamespaces()

public Namespaces getSelectedNamespaces()

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Returns
TypeDescription
Namespaces

The selectedNamespaces.

getSelectedNamespacesBuilder()

public Namespaces.Builder getSelectedNamespacesBuilder()

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Returns
TypeDescription
Namespaces.Builder

getSelectedNamespacesOrBuilder()

public NamespacesOrBuilder getSelectedNamespacesOrBuilder()

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Returns
TypeDescription
NamespacesOrBuilder

hasAllNamespaces()

public boolean hasAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
TypeDescription
boolean

Whether the allNamespaces field is set.

hasEncryptionKey()

public boolean hasEncryptionKey()

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Returns
TypeDescription
boolean

Whether the encryptionKey field is set.

hasSelectedApplications()

public boolean hasSelectedApplications()

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Returns
TypeDescription
boolean

Whether the selectedApplications field is set.

hasSelectedNamespaces()

public boolean hasSelectedNamespaces()

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Returns
TypeDescription
boolean

Whether the selectedNamespaces field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEncryptionKey(EncryptionKey value)

public BackupPlan.BackupConfig.Builder mergeEncryptionKey(EncryptionKey value)

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Parameter
NameDescription
valueEncryptionKey
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

mergeFrom(BackupPlan.BackupConfig other)

public BackupPlan.BackupConfig.Builder mergeFrom(BackupPlan.BackupConfig other)
Parameter
NameDescription
otherBackupPlan.BackupConfig
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackupPlan.BackupConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BackupPlan.BackupConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

mergeSelectedApplications(NamespacedNames value)

public BackupPlan.BackupConfig.Builder mergeSelectedApplications(NamespacedNames value)

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Parameter
NameDescription
valueNamespacedNames
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

mergeSelectedNamespaces(Namespaces value)

public BackupPlan.BackupConfig.Builder mergeSelectedNamespaces(Namespaces value)

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Parameter
NameDescription
valueNamespaces
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.BackupConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

setAllNamespaces(boolean value)

public BackupPlan.BackupConfig.Builder setAllNamespaces(boolean value)

If True, include all namespaced resources

bool all_namespaces = 1;

Parameter
NameDescription
valueboolean

The allNamespaces to set.

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

setEncryptionKey(EncryptionKey value)

public BackupPlan.BackupConfig.Builder setEncryptionKey(EncryptionKey value)

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Parameter
NameDescription
valueEncryptionKey
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setEncryptionKey(EncryptionKey.Builder builderForValue)

public BackupPlan.BackupConfig.Builder setEncryptionKey(EncryptionKey.Builder builderForValue)

This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.

.google.cloud.gkebackup.v1.EncryptionKey encryption_key = 6;

Parameter
NameDescription
builderForValueEncryptionKey.Builder
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.BackupConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

setIncludeSecrets(boolean value)

public BackupPlan.BackupConfig.Builder setIncludeSecrets(boolean value)

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

bool include_secrets = 5;

Parameter
NameDescription
valueboolean

The includeSecrets to set.

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

setIncludeVolumeData(boolean value)

public BackupPlan.BackupConfig.Builder setIncludeVolumeData(boolean value)

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False

bool include_volume_data = 4;

Parameter
NameDescription
valueboolean

The includeVolumeData to set.

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackupPlan.BackupConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

setSelectedApplications(NamespacedNames value)

public BackupPlan.BackupConfig.Builder setSelectedApplications(NamespacedNames value)

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Parameter
NameDescription
valueNamespacedNames
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setSelectedApplications(NamespacedNames.Builder builderForValue)

public BackupPlan.BackupConfig.Builder setSelectedApplications(NamespacedNames.Builder builderForValue)

If set, include just the resources referenced by the listed ProtectedApplications.

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;

Parameter
NameDescription
builderForValueNamespacedNames.Builder
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setSelectedNamespaces(Namespaces value)

public BackupPlan.BackupConfig.Builder setSelectedNamespaces(Namespaces value)

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Parameter
NameDescription
valueNamespaces
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setSelectedNamespaces(Namespaces.Builder builderForValue)

public BackupPlan.BackupConfig.Builder setSelectedNamespaces(Namespaces.Builder builderForValue)

If set, include just the resources in the listed namespaces.

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 2;

Parameter
NameDescription
builderForValueNamespaces.Builder
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.BackupConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides