Class BackupPlan.BackupConfig (0.45.0)

Version 0.45.0

• 0.52.0 (latest)
• 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 extends GeneratedMessageV3 implements BackupPlan.BackupConfigOrBuilder

BackupConfig defines the configuration of Backups created via this BackupPlan.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BackupPlan.BackupConfig

Implements

BackupPlan.BackupConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALL_NAMESPACES_FIELD_NUMBER

public static final int ALL_NAMESPACES_FIELD_NUMBER

Field Value
Type	Description
int

ENCRYPTION_KEY_FIELD_NUMBER

public static final int ENCRYPTION_KEY_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_SECRETS_FIELD_NUMBER

public static final int INCLUDE_SECRETS_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_VOLUME_DATA_FIELD_NUMBER

public static final int INCLUDE_VOLUME_DATA_FIELD_NUMBER

Field Value
Type	Description
int

PERMISSIVE_MODE_FIELD_NUMBER

public static final int PERMISSIVE_MODE_FIELD_NUMBER

Field Value
Type	Description
int

SELECTED_APPLICATIONS_FIELD_NUMBER

public static final int SELECTED_APPLICATIONS_FIELD_NUMBER

Field Value
Type	Description
int

SELECTED_NAMESPACES_FIELD_NUMBER

public static final int SELECTED_NAMESPACES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BackupPlan.BackupConfig getDefaultInstance()

Returns
Type	Description
BackupPlan.BackupConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BackupPlan.BackupConfig.Builder newBuilder()

Returns
Type	Description
BackupPlan.BackupConfig.Builder

newBuilder(BackupPlan.BackupConfig prototype)

public static BackupPlan.BackupConfig.Builder newBuilder(BackupPlan.BackupConfig prototype)

Parameter
Name	Description
prototype	BackupPlan.BackupConfig

Returns
Type	Description
BackupPlan.BackupConfig.Builder

parseDelimitedFrom(InputStream input)

public static BackupPlan.BackupConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BackupPlan.BackupConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupPlan.BackupConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupPlan.BackupConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BackupPlan.BackupConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BackupPlan.BackupConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BackupPlan.BackupConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BackupPlan.BackupConfig> parser()

Returns
Type	Description
Parser<BackupConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.

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.

getParserForType()

public Parser<BackupPlan.BackupConfig> getParserForType()

Returns
Type	Description
Parser<BackupConfig>

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BackupPlan.BackupConfig.Builder newBuilderForType()

Returns
Type	Description
BackupPlan.BackupConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackupPlan.BackupConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BackupPlan.BackupConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BackupPlan.BackupConfig.Builder toBuilder()

Returns
Type	Description
BackupPlan.BackupConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException