Class BackupPlan.BackupConfig (0.19.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

Static Fields

ALL_NAMESPACES_FIELD_NUMBER

public static final int ALL_NAMESPACES_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_KEY_FIELD_NUMBER

public static final int ENCRYPTION_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_SECRETS_FIELD_NUMBER

public static final int INCLUDE_SECRETS_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_VOLUME_DATA_FIELD_NUMBER

public static final int INCLUDE_VOLUME_DATA_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_APPLICATIONS_FIELD_NUMBER

public static final int SELECTED_APPLICATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_NAMESPACES_FIELD_NUMBER

public static final int SELECTED_NAMESPACES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BackupPlan.BackupConfig getDefaultInstance()
Returns
TypeDescription
BackupPlan.BackupConfig

getDescriptor()

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

newBuilder()

public static BackupPlan.BackupConfig.Builder newBuilder()
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

newBuilder(BackupPlan.BackupConfig prototype)

public static BackupPlan.BackupConfig.Builder newBuilder(BackupPlan.BackupConfig prototype)
Parameter
NameDescription
prototypeBackupPlan.BackupConfig
Returns
TypeDescription
BackupPlan.BackupConfig.Builder

parseDelimitedFrom(InputStream input)

public static BackupPlan.BackupConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BackupPlan.BackupConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupPlan.BackupConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupPlan.BackupConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BackupPlan.BackupConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BackupPlan.BackupConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.BackupConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.BackupConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BackupPlan.BackupConfig> parser()
Returns
TypeDescription
Parser<BackupConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

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.

getParserForType()

public Parser<BackupPlan.BackupConfig> getParserForType()
Returns
TypeDescription
Parser<BackupConfig>
Overrides

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackupPlan.BackupConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BackupPlan.BackupConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException