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

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException