Class BackupPlan.BackupConfig

  • All Implemented Interfaces:
    BackupPlan.BackupConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    BackupPlan

    public static final class BackupPlan.BackupConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements BackupPlan.BackupConfigOrBuilder
     BackupConfig defines the configuration of Backups created via this
     BackupPlan.
     
    Protobuf type google.cloud.gkebackup.v1.BackupPlan.BackupConfig
    See Also:
    Serialized Form
    • Field Detail

      • ALL_NAMESPACES_FIELD_NUMBER

        public static final int ALL_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SELECTED_NAMESPACES_FIELD_NUMBER

        public static final int SELECTED_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SELECTED_APPLICATIONS_FIELD_NUMBER

        public static final int SELECTED_APPLICATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INCLUDE_VOLUME_DATA_FIELD_NUMBER

        public static final int INCLUDE_VOLUME_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INCLUDE_SECRETS_FIELD_NUMBER

        public static final int INCLUDE_SECRETS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ENCRYPTION_KEY_FIELD_NUMBER

        public static final int ENCRYPTION_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasAllNamespaces

        public boolean hasAllNamespaces()
         If True, include all namespaced resources
         
        bool all_namespaces = 1;
        Specified by:
        hasAllNamespaces in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        Whether the allNamespaces 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;
        Specified by:
        hasSelectedNamespaces in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        Whether the selectedNamespaces 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;
        Specified by:
        hasSelectedApplications in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        Whether the selectedApplications field is set.
      • getSelectedApplications

        public NamespacedNames getSelectedApplications()
         If set, include just the resources referenced by the listed
         ProtectedApplications.
         
        .google.cloud.gkebackup.v1.NamespacedNames selected_applications = 3;
        Specified by:
        getSelectedApplications in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        The selectedApplications.
      • 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;
        Specified by:
        getIncludeVolumeData in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        The includeVolumeData.
      • 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;
        Specified by:
        getIncludeSecrets in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        The includeSecrets.
      • 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;
        Specified by:
        hasEncryptionKey in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        Whether the encryptionKey field is set.
      • 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;
        Specified by:
        getEncryptionKey in interface BackupPlan.BackupConfigOrBuilder
        Returns:
        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;
        Specified by:
        getEncryptionKeyOrBuilder in interface BackupPlan.BackupConfigOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.BackupConfig parseFrom​(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public BackupPlan.BackupConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public BackupPlan.BackupConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected BackupPlan.BackupConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<BackupPlan.BackupConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public BackupPlan.BackupConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder