Class BackupPlan.Builder

  • All Implemented Interfaces:
    BackupPlanOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    BackupPlan

    public static final class BackupPlan.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
    implements BackupPlanOrBuilder
     Defines the configuration and scheduling for a "line" of Backups.
     
    Protobuf type google.cloud.gkebackup.v1.BackupPlan
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • clear

        public BackupPlan.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • getDefaultInstanceForType

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

        public BackupPlan build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public BackupPlan buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public BackupPlan.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • setField

        public BackupPlan.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • clearField

        public BackupPlan.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • clearOneof

        public BackupPlan.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • setRepeatedField

        public BackupPlan.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • addRepeatedField

        public BackupPlan.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • mergeFrom

        public BackupPlan.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BackupPlan.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • mergeFrom

        public BackupPlan.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BackupPlan.Builder>
        Throws:
        IOException
      • getName

        public String getName()
         Output only. The full name of the BackupPlan resource.
         Format: `projects/*/locations/*/backupPlans/*`
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface BackupPlanOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The full name of the BackupPlan resource.
         Format: `projects/*/locations/*/backupPlans/*`
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for name.
      • setName

        public BackupPlan.Builder setName​(String value)
         Output only. The full name of the BackupPlan resource.
         Format: `projects/*/locations/*/backupPlans/*`
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public BackupPlan.Builder clearName()
         Output only. The full name of the BackupPlan resource.
         Format: `projects/*/locations/*/backupPlans/*`
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setNameBytes

        public BackupPlan.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The full name of the BackupPlan resource.
         Format: `projects/*/locations/*/backupPlans/*`
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getUid

        public String getUid()
         Output only. Server generated global unique identifier of
         [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface BackupPlanOrBuilder
        Returns:
        The uid.
      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. Server generated global unique identifier of
         [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for uid.
      • setUid

        public BackupPlan.Builder setUid​(String value)
         Output only. Server generated global unique identifier of
         [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The uid to set.
        Returns:
        This builder for chaining.
      • clearUid

        public BackupPlan.Builder clearUid()
         Output only. Server generated global unique identifier of
         [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setUidBytes

        public BackupPlan.Builder setUidBytes​(com.google.protobuf.ByteString value)
         Output only. Server generated global unique identifier of
         [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for uid to set.
        Returns:
        This builder for chaining.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface BackupPlanOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface BackupPlanOrBuilder
        Returns:
        The createTime.
      • setCreateTime

        public BackupPlan.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public BackupPlan.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public BackupPlan.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCreateTime

        public BackupPlan.Builder clearCreateTime()
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when this BackupPlan resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface BackupPlanOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface BackupPlanOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface BackupPlanOrBuilder
        Returns:
        The updateTime.
      • setUpdateTime

        public BackupPlan.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setUpdateTime

        public BackupPlan.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeUpdateTime

        public BackupPlan.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearUpdateTime

        public BackupPlan.Builder clearUpdateTime()
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when this BackupPlan resource was last
         updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface BackupPlanOrBuilder
      • getDescription

        public String getDescription()
         User specified descriptive string for this BackupPlan.
         
        string description = 5;
        Specified by:
        getDescription in interface BackupPlanOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         User specified descriptive string for this BackupPlan.
         
        string description = 5;
        Specified by:
        getDescriptionBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for description.
      • setDescription

        public BackupPlan.Builder setDescription​(String value)
         User specified descriptive string for this BackupPlan.
         
        string description = 5;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.
      • clearDescription

        public BackupPlan.Builder clearDescription()
         User specified descriptive string for this BackupPlan.
         
        string description = 5;
        Returns:
        This builder for chaining.
      • setDescriptionBytes

        public BackupPlan.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         User specified descriptive string for this BackupPlan.
         
        string description = 5;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.
      • getCluster

        public String getCluster()
         Required. Immutable. The source cluster from which Backups will be created
         via this BackupPlan. Valid formats:
        
         - `projects/*/locations/*/clusters/*`
         - `projects/*/zones/*/clusters/*`
         
        string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getCluster in interface BackupPlanOrBuilder
        Returns:
        The cluster.
      • getClusterBytes

        public com.google.protobuf.ByteString getClusterBytes()
         Required. Immutable. The source cluster from which Backups will be created
         via this BackupPlan. Valid formats:
        
         - `projects/*/locations/*/clusters/*`
         - `projects/*/zones/*/clusters/*`
         
        string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getClusterBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for cluster.
      • setCluster

        public BackupPlan.Builder setCluster​(String value)
         Required. Immutable. The source cluster from which Backups will be created
         via this BackupPlan. Valid formats:
        
         - `projects/*/locations/*/clusters/*`
         - `projects/*/zones/*/clusters/*`
         
        string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The cluster to set.
        Returns:
        This builder for chaining.
      • clearCluster

        public BackupPlan.Builder clearCluster()
         Required. Immutable. The source cluster from which Backups will be created
         via this BackupPlan. Valid formats:
        
         - `projects/*/locations/*/clusters/*`
         - `projects/*/zones/*/clusters/*`
         
        string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setClusterBytes

        public BackupPlan.Builder setClusterBytes​(com.google.protobuf.ByteString value)
         Required. Immutable. The source cluster from which Backups will be created
         via this BackupPlan. Valid formats:
        
         - `projects/*/locations/*/clusters/*`
         - `projects/*/zones/*/clusters/*`
         
        string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for cluster to set.
        Returns:
        This builder for chaining.
      • hasRetentionPolicy

        public boolean hasRetentionPolicy()
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
        Specified by:
        hasRetentionPolicy in interface BackupPlanOrBuilder
        Returns:
        Whether the retentionPolicy field is set.
      • getRetentionPolicy

        public BackupPlan.RetentionPolicy getRetentionPolicy()
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
        Specified by:
        getRetentionPolicy in interface BackupPlanOrBuilder
        Returns:
        The retentionPolicy.
      • setRetentionPolicy

        public BackupPlan.Builder setRetentionPolicy​(BackupPlan.RetentionPolicy value)
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
      • setRetentionPolicy

        public BackupPlan.Builder setRetentionPolicy​(BackupPlan.RetentionPolicy.Builder builderForValue)
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
      • mergeRetentionPolicy

        public BackupPlan.Builder mergeRetentionPolicy​(BackupPlan.RetentionPolicy value)
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
      • clearRetentionPolicy

        public BackupPlan.Builder clearRetentionPolicy()
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
      • getRetentionPolicyBuilder

        public BackupPlan.RetentionPolicy.Builder getRetentionPolicyBuilder()
         RetentionPolicy governs lifecycle of Backups created under this plan.
         
        .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
      • containsLabels

        public boolean containsLabels​(String key)
         A set of custom labels supplied by user.
         
        map<string, string> labels = 8;
        Specified by:
        containsLabels in interface BackupPlanOrBuilder
      • removeLabels

        public BackupPlan.Builder removeLabels​(String key)
         A set of custom labels supplied by user.
         
        map<string, string> labels = 8;
      • getMutableLabels

        @Deprecated
        public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.
      • putLabels

        public BackupPlan.Builder putLabels​(String key,
                                            String value)
         A set of custom labels supplied by user.
         
        map<string, string> labels = 8;
      • hasBackupSchedule

        public boolean hasBackupSchedule()
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
        Specified by:
        hasBackupSchedule in interface BackupPlanOrBuilder
        Returns:
        Whether the backupSchedule field is set.
      • getBackupSchedule

        public BackupPlan.Schedule getBackupSchedule()
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
        Specified by:
        getBackupSchedule in interface BackupPlanOrBuilder
        Returns:
        The backupSchedule.
      • setBackupSchedule

        public BackupPlan.Builder setBackupSchedule​(BackupPlan.Schedule value)
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
      • setBackupSchedule

        public BackupPlan.Builder setBackupSchedule​(BackupPlan.Schedule.Builder builderForValue)
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
      • mergeBackupSchedule

        public BackupPlan.Builder mergeBackupSchedule​(BackupPlan.Schedule value)
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
      • clearBackupSchedule

        public BackupPlan.Builder clearBackupSchedule()
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
      • getBackupScheduleBuilder

        public BackupPlan.Schedule.Builder getBackupScheduleBuilder()
         Defines a schedule for automatic Backup creation via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
      • getEtag

        public String getEtag()
         Output only. `etag` is used for optimistic concurrency control as a way to
         help prevent simultaneous updates of a backup plan from overwriting each
         other. It is strongly suggested that systems make use of the 'etag' in the
         read-modify-write cycle to perform BackupPlan updates in order to avoid
         race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         and systems are expected to put that etag in the request to
         `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
         will be applied to the same version of the resource.
         
        string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtag in interface BackupPlanOrBuilder
        Returns:
        The etag.
      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Output only. `etag` is used for optimistic concurrency control as a way to
         help prevent simultaneous updates of a backup plan from overwriting each
         other. It is strongly suggested that systems make use of the 'etag' in the
         read-modify-write cycle to perform BackupPlan updates in order to avoid
         race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         and systems are expected to put that etag in the request to
         `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
         will be applied to the same version of the resource.
         
        string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtagBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for etag.
      • setEtag

        public BackupPlan.Builder setEtag​(String value)
         Output only. `etag` is used for optimistic concurrency control as a way to
         help prevent simultaneous updates of a backup plan from overwriting each
         other. It is strongly suggested that systems make use of the 'etag' in the
         read-modify-write cycle to perform BackupPlan updates in order to avoid
         race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         and systems are expected to put that etag in the request to
         `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
         will be applied to the same version of the resource.
         
        string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The etag to set.
        Returns:
        This builder for chaining.
      • clearEtag

        public BackupPlan.Builder clearEtag()
         Output only. `etag` is used for optimistic concurrency control as a way to
         help prevent simultaneous updates of a backup plan from overwriting each
         other. It is strongly suggested that systems make use of the 'etag' in the
         read-modify-write cycle to perform BackupPlan updates in order to avoid
         race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         and systems are expected to put that etag in the request to
         `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
         will be applied to the same version of the resource.
         
        string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setEtagBytes

        public BackupPlan.Builder setEtagBytes​(com.google.protobuf.ByteString value)
         Output only. `etag` is used for optimistic concurrency control as a way to
         help prevent simultaneous updates of a backup plan from overwriting each
         other. It is strongly suggested that systems make use of the 'etag' in the
         read-modify-write cycle to perform BackupPlan updates in order to avoid
         race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         and systems are expected to put that etag in the request to
         `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
         will be applied to the same version of the resource.
         
        string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for etag to set.
        Returns:
        This builder for chaining.
      • getDeactivated

        public boolean getDeactivated()
         This flag indicates whether this BackupPlan has been deactivated.
         Setting this field to True locks the BackupPlan such that no further
         updates will be allowed (except deletes), including the deactivated field
         itself. It also prevents any new Backups from being created via this
         BackupPlan (including scheduled Backups).
        
         Default: False
         
        bool deactivated = 11;
        Specified by:
        getDeactivated in interface BackupPlanOrBuilder
        Returns:
        The deactivated.
      • setDeactivated

        public BackupPlan.Builder setDeactivated​(boolean value)
         This flag indicates whether this BackupPlan has been deactivated.
         Setting this field to True locks the BackupPlan such that no further
         updates will be allowed (except deletes), including the deactivated field
         itself. It also prevents any new Backups from being created via this
         BackupPlan (including scheduled Backups).
        
         Default: False
         
        bool deactivated = 11;
        Parameters:
        value - The deactivated to set.
        Returns:
        This builder for chaining.
      • clearDeactivated

        public BackupPlan.Builder clearDeactivated()
         This flag indicates whether this BackupPlan has been deactivated.
         Setting this field to True locks the BackupPlan such that no further
         updates will be allowed (except deletes), including the deactivated field
         itself. It also prevents any new Backups from being created via this
         BackupPlan (including scheduled Backups).
        
         Default: False
         
        bool deactivated = 11;
        Returns:
        This builder for chaining.
      • hasBackupConfig

        public boolean hasBackupConfig()
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
        Specified by:
        hasBackupConfig in interface BackupPlanOrBuilder
        Returns:
        Whether the backupConfig field is set.
      • getBackupConfig

        public BackupPlan.BackupConfig getBackupConfig()
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
        Specified by:
        getBackupConfig in interface BackupPlanOrBuilder
        Returns:
        The backupConfig.
      • setBackupConfig

        public BackupPlan.Builder setBackupConfig​(BackupPlan.BackupConfig value)
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
      • setBackupConfig

        public BackupPlan.Builder setBackupConfig​(BackupPlan.BackupConfig.Builder builderForValue)
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
      • mergeBackupConfig

        public BackupPlan.Builder mergeBackupConfig​(BackupPlan.BackupConfig value)
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
      • clearBackupConfig

        public BackupPlan.Builder clearBackupConfig()
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
      • getBackupConfigBuilder

        public BackupPlan.BackupConfig.Builder getBackupConfigBuilder()
         Defines the configuration of Backups created via this BackupPlan.
         
        .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
      • getProtectedPodCount

        public int getProtectedPodCount()
         Output only. The number of Kubernetes Pods backed up in the
         last successful Backup created via this BackupPlan.
         
        int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProtectedPodCount in interface BackupPlanOrBuilder
        Returns:
        The protectedPodCount.
      • setProtectedPodCount

        public BackupPlan.Builder setProtectedPodCount​(int value)
         Output only. The number of Kubernetes Pods backed up in the
         last successful Backup created via this BackupPlan.
         
        int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The protectedPodCount to set.
        Returns:
        This builder for chaining.
      • clearProtectedPodCount

        public BackupPlan.Builder clearProtectedPodCount()
         Output only. The number of Kubernetes Pods backed up in the
         last successful Backup created via this BackupPlan.
         
        int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • getStateValue

        public int getStateValue()
         Output only. State of the BackupPlan. This State field reflects the
         various stages a BackupPlan can be in
         during the Create operation. It will be set to "DEACTIVATED"
         if the BackupPlan is deactivated on an Update
         
        .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface BackupPlanOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • setStateValue

        public BackupPlan.Builder setStateValue​(int value)
         Output only. State of the BackupPlan. This State field reflects the
         various stages a BackupPlan can be in
         during the Create operation. It will be set to "DEACTIVATED"
         if the BackupPlan is deactivated on an Update
         
        .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.
      • getState

        public BackupPlan.State getState()
         Output only. State of the BackupPlan. This State field reflects the
         various stages a BackupPlan can be in
         during the Create operation. It will be set to "DEACTIVATED"
         if the BackupPlan is deactivated on an Update
         
        .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface BackupPlanOrBuilder
        Returns:
        The state.
      • setState

        public BackupPlan.Builder setState​(BackupPlan.State value)
         Output only. State of the BackupPlan. This State field reflects the
         various stages a BackupPlan can be in
         during the Create operation. It will be set to "DEACTIVATED"
         if the BackupPlan is deactivated on an Update
         
        .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.
      • clearState

        public BackupPlan.Builder clearState()
         Output only. State of the BackupPlan. This State field reflects the
         various stages a BackupPlan can be in
         during the Create operation. It will be set to "DEACTIVATED"
         if the BackupPlan is deactivated on an Update
         
        .google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • getStateReason

        public String getStateReason()
         Output only. Human-readable description of why BackupPlan is in the current
         `state`
         
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateReason in interface BackupPlanOrBuilder
        Returns:
        The stateReason.
      • getStateReasonBytes

        public com.google.protobuf.ByteString getStateReasonBytes()
         Output only. Human-readable description of why BackupPlan is in the current
         `state`
         
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateReasonBytes in interface BackupPlanOrBuilder
        Returns:
        The bytes for stateReason.
      • setStateReason

        public BackupPlan.Builder setStateReason​(String value)
         Output only. Human-readable description of why BackupPlan is in the current
         `state`
         
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The stateReason to set.
        Returns:
        This builder for chaining.
      • clearStateReason

        public BackupPlan.Builder clearStateReason()
         Output only. Human-readable description of why BackupPlan is in the current
         `state`
         
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setStateReasonBytes

        public BackupPlan.Builder setStateReasonBytes​(com.google.protobuf.ByteString value)
         Output only. Human-readable description of why BackupPlan is in the current
         `state`
         
        string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for stateReason to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final BackupPlan.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>
      • mergeUnknownFields

        public final BackupPlan.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BackupPlan.Builder>