Class BackupPlan.BackupConfig.Builder (0.86.0)

0.86.0 (latest) 0.84.0 0.82.0 0.81.0 0.80.0 0.79.0 0.77.0 0.75.0 0.74.0 0.73.0 0.72.0 0.71.0 0.69.0 0.67.0 0.66.0 0.63.0 0.62.0 0.61.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.6 0.1.0

public static final class BackupPlan.BackupConfig.Builder extends GeneratedMessage.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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BackupPlan.BackupConfig.Builder

Implements

BackupPlan.BackupConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public BackupPlan.BackupConfig build()

Returns
Type	Description
BackupPlan.BackupConfig

buildPartial()

public BackupPlan.BackupConfig buildPartial()

Returns
Type	Description
BackupPlan.BackupConfig

clear()

public BackupPlan.BackupConfig.Builder clear()

Returns
Type	Description
BackupPlan.BackupConfig.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAllNamespaces()

public BackupPlan.BackupConfig.Builder clearAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

clearBackupScope()

public BackupPlan.BackupConfig.Builder clearBackupScope()

Returns
Type	Description
BackupPlan.BackupConfig.Builder

clearEncryptionKey()

public BackupPlan.BackupConfig.Builder clearEncryptionKey()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BackupPlan.BackupConfig.Builder

clearIncludeSecrets()

public BackupPlan.BackupConfig.Builder clearIncludeSecrets()

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

Default: False

bool include_secrets = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

clearIncludeVolumeData()

public BackupPlan.BackupConfig.Builder clearIncludeVolumeData()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

clearPermissiveMode()

public BackupPlan.BackupConfig.Builder clearPermissiveMode()

Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

Default: False

bool permissive_mode = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

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
Type	Description
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
Type	Description
BackupPlan.BackupConfig.Builder

getAllNamespaces()

public boolean getAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
Type	Description
boolean	The allNamespaces.

getBackupScopeCase()

public BackupPlan.BackupConfig.BackupScopeCase getBackupScopeCase()

Returns
Type	Description
BackupPlan.BackupConfig.BackupScopeCase

getDefaultInstanceForType()

public BackupPlan.BackupConfig getDefaultInstanceForType()

Returns
Type	Description
BackupPlan.BackupConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEncryptionKey()

public EncryptionKey getEncryptionKey()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EncryptionKey	The encryptionKey.

getEncryptionKeyBuilder()

public EncryptionKey.Builder getEncryptionKeyBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EncryptionKey.Builder

getEncryptionKeyOrBuilder()

public EncryptionKeyOrBuilder getEncryptionKeyOrBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EncryptionKeyOrBuilder

getIncludeSecrets()

public boolean getIncludeSecrets()

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

Default: False

bool include_secrets = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The includeSecrets.

getIncludeVolumeData()

public boolean getIncludeVolumeData()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The includeVolumeData.

getPermissiveMode()

public boolean getPermissiveMode()

Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

Default: False

bool permissive_mode = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The permissiveMode.

getSelectedApplications()

public NamespacedNames getSelectedApplications()

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

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

Returns
Type	Description
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
Type	Description
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
Type	Description
NamespacedNamesOrBuilder

getSelectedNamespaces()

public Namespaces getSelectedNamespaces()

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

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

Returns
Type	Description
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
Type	Description
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
Type	Description
NamespacesOrBuilder

hasAllNamespaces()

public boolean hasAllNamespaces()

If True, include all namespaced resources

bool all_namespaces = 1;

Returns
Type	Description
boolean	Whether the allNamespaces field is set.

hasEncryptionKey()

public boolean hasEncryptionKey()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
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
Type	Description
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
Type	Description
boolean	Whether the selectedNamespaces field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeEncryptionKey(EncryptionKey value)

public BackupPlan.BackupConfig.Builder mergeEncryptionKey(EncryptionKey value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	EncryptionKey

Returns
Type	Description
BackupPlan.BackupConfig.Builder

mergeFrom(BackupPlan.BackupConfig other)

public BackupPlan.BackupConfig.Builder mergeFrom(BackupPlan.BackupConfig other)

Parameter
Name	Description
other	BackupPlan.BackupConfig

Returns
Type	Description
BackupPlan.BackupConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackupPlan.BackupConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BackupPlan.BackupConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BackupPlan.BackupConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
value	NamespacedNames

Returns
Type	Description
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
Name	Description
value	Namespaces

Returns
Type	Description
BackupPlan.BackupConfig.Builder

setAllNamespaces(boolean value)

public BackupPlan.BackupConfig.Builder setAllNamespaces(boolean value)

If True, include all namespaced resources

bool all_namespaces = 1;

Parameter
Name	Description
value	boolean The allNamespaces to set.

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

setEncryptionKey(EncryptionKey value)

public BackupPlan.BackupConfig.Builder setEncryptionKey(EncryptionKey value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	EncryptionKey

Returns
Type	Description
BackupPlan.BackupConfig.Builder

setEncryptionKey(EncryptionKey.Builder builderForValue)

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

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	EncryptionKey.Builder

Returns
Type	Description
BackupPlan.BackupConfig.Builder

setIncludeSecrets(boolean value)

public BackupPlan.BackupConfig.Builder setIncludeSecrets(boolean value)

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

Default: False

bool include_secrets = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The includeSecrets to set.

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

setIncludeVolumeData(boolean value)

public BackupPlan.BackupConfig.Builder setIncludeVolumeData(boolean value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The includeVolumeData to set.

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

setPermissiveMode(boolean value)

public BackupPlan.BackupConfig.Builder setPermissiveMode(boolean value)

Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

Default: False

bool permissive_mode = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The permissiveMode to set.

Returns
Type	Description
BackupPlan.BackupConfig.Builder	This builder for chaining.

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
Name	Description
value	NamespacedNames

Returns
Type	Description
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
Name	Description
builderForValue	NamespacedNames.Builder

Returns
Type	Description
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
Name	Description
value	Namespaces

Returns
Type	Description
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
Name	Description
builderForValue	Namespaces.Builder

Returns
Type	Description
BackupPlan.BackupConfig.Builder