Package com.google.cloud.gkebackup.v1

Class BackupPlan

  • All Implemented Interfaces:
    BackupPlanOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BackupPlan
extends com.google.protobuf.GeneratedMessageV3
implements BackupPlanOrBuilder
     Defines the configuration and scheduling for a "line" of Backups.
    Protobuf type google.cloud.gkebackup.v1.BackupPlan
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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 parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static BackupPlan 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 parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static BackupPlan parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static BackupPlan getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<BackupPlan> parser()

      • getParserForType

        public com.google.protobuf.Parser<BackupPlan> 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 getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder