Package com.google.cloud.gkebackup.v1

Class Restore

  • All Implemented Interfaces:
    RestoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Restore
extends com.google.protobuf.GeneratedMessageV3
implements RestoreOrBuilder
     Represents both a request to Restore some portion of a Backup into
 a target GKE cluster and a record of the restore operation itself.
 Next id: 18
    Protobuf type google.cloud.gkebackup.v1.Restore
    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 Restore resource.
 Format: `projects/*/locations/*/restorePlans/*/restores/*`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface RestoreOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The full name of the Restore resource.
 Format: `projects/*/locations/*/restorePlans/*/restores/*`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface RestoreOrBuilder
        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 RestoreOrBuilder
        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 RestoreOrBuilder
        Returns:
        The bytes for uid.

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • getDescription

        public String getDescription()
         User specified descriptive string for this Restore.
        string description = 5;
        Specified by:
        getDescription in interface RestoreOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • getBackup

        public String getBackup()
         Required. Immutable. A reference to the
 [Backup][google.cloud.gkebackup.v1.Backup] used as the source from which
 this Restore will restore. Note that this Backup must be a sub-resource of
 the RestorePlan's
 [backup_plan][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format:
 `projects/*/locations/*/backupPlans/*/backups/*`.
        string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getBackup in interface RestoreOrBuilder
        Returns:
        The backup.

      • getBackupBytes

        public com.google.protobuf.ByteString getBackupBytes()
         Required. Immutable. A reference to the
 [Backup][google.cloud.gkebackup.v1.Backup] used as the source from which
 this Restore will restore. Note that this Backup must be a sub-resource of
 the RestorePlan's
 [backup_plan][google.cloud.gkebackup.v1.RestorePlan.backup_plan]. Format:
 `projects/*/locations/*/backupPlans/*/backups/*`.
        string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getBackupBytes in interface RestoreOrBuilder
        Returns:
        The bytes for backup.

      • getCluster

        public String getCluster()
         Output only. The target cluster into which this Restore will restore data.
 Valid formats:

   - `projects/*/locations/*/clusters/*`
   - `projects/*/zones/*/clusters/*`

 Inherited from parent RestorePlan's
 [cluster][google.cloud.gkebackup.v1.RestorePlan.cluster] value.
        string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getCluster in interface RestoreOrBuilder
        Returns:
        The cluster.

      • getClusterBytes

        public com.google.protobuf.ByteString getClusterBytes()
         Output only. The target cluster into which this Restore will restore data.
 Valid formats:

   - `projects/*/locations/*/clusters/*`
   - `projects/*/zones/*/clusters/*`

 Inherited from parent RestorePlan's
 [cluster][google.cloud.gkebackup.v1.RestorePlan.cluster] value.
        string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getClusterBytes in interface RestoreOrBuilder
        Returns:
        The bytes for cluster.

      • hasRestoreConfig

        public boolean hasRestoreConfig()
         Output only. Configuration of the Restore.  Inherited from parent
 RestorePlan's
 [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasRestoreConfig in interface RestoreOrBuilder
        Returns:
        Whether the restoreConfig field is set.

      • getRestoreConfig

        public RestoreConfig getRestoreConfig()
         Output only. Configuration of the Restore.  Inherited from parent
 RestorePlan's
 [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRestoreConfig in interface RestoreOrBuilder
        Returns:
        The restoreConfig.

      • getRestoreConfigOrBuilder

        public RestoreConfigOrBuilder getRestoreConfigOrBuilder()
         Output only. Configuration of the Restore.  Inherited from parent
 RestorePlan's
 [restore_config][google.cloud.gkebackup.v1.RestorePlan.restore_config].
        .google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRestoreConfigOrBuilder in interface RestoreOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: RestoreOrBuilder
         A set of custom labels supplied by user.
        map<string, string> labels = 9;
        Specified by:
        getLabelsCount in interface RestoreOrBuilder

      • containsLabels

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

      • getStateValue

        public int getStateValue()
         Output only. The current state of the Restore.
        .google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface RestoreOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Restore.State getState()
         Output only. The current state of the Restore.
        .google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface RestoreOrBuilder
        Returns:
        The state.

      • getStateReason

        public String getStateReason()
         Output only. Human-readable description of why the Restore is in its
 current state.
        string state_reason = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateReason in interface RestoreOrBuilder
        Returns:
        The stateReason.

      • getStateReasonBytes

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

      • hasCompleteTime

        public boolean hasCompleteTime()
         Output only. Timestamp of when the restore operation completed.
        .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCompleteTime in interface RestoreOrBuilder
        Returns:
        Whether the completeTime field is set.

      • getCompleteTime

        public com.google.protobuf.Timestamp getCompleteTime()
         Output only. Timestamp of when the restore operation completed.
        .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompleteTime in interface RestoreOrBuilder
        Returns:
        The completeTime.

      • getCompleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
         Output only. Timestamp of when the restore operation completed.
        .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompleteTimeOrBuilder in interface RestoreOrBuilder

      • getResourcesRestoredCount

        public int getResourcesRestoredCount()
         Output only. Number of resources restored during the restore execution.
        int32 resources_restored_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getResourcesRestoredCount in interface RestoreOrBuilder
        Returns:
        The resourcesRestoredCount.

      • getResourcesExcludedCount

        public int getResourcesExcludedCount()
         Output only. Number of resources excluded during the restore execution.
        int32 resources_excluded_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getResourcesExcludedCount in interface RestoreOrBuilder
        Returns:
        The resourcesExcludedCount.

      • getResourcesFailedCount

        public int getResourcesFailedCount()
         Output only. Number of resources that failed to be restored during the
 restore execution.
        int32 resources_failed_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getResourcesFailedCount in interface RestoreOrBuilder
        Returns:
        The resourcesFailedCount.

      • getVolumesRestoredCount

        public int getVolumesRestoredCount()
         Output only. Number of volumes restored during the restore execution.
        int32 volumes_restored_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVolumesRestoredCount in interface RestoreOrBuilder
        Returns:
        The volumesRestoredCount.

      • getEtag

        public String getEtag()
         Output only. `etag` is used for optimistic concurrency control as a way to
 help prevent simultaneous updates of a restore from overwriting each other.
 It is strongly suggested that systems make use of the `etag` in the
 read-modify-write cycle to perform restore updates in order to avoid
 race conditions: An `etag` is returned in the response to `GetRestore`,
 and systems are expected to put that etag in the request to
 `UpdateRestore` or `DeleteRestore` to ensure that their change will be
 applied to the same version of the resource.
        string etag = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtag in interface RestoreOrBuilder
        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 restore from overwriting each other.
 It is strongly suggested that systems make use of the `etag` in the
 read-modify-write cycle to perform restore updates in order to avoid
 race conditions: An `etag` is returned in the response to `GetRestore`,
 and systems are expected to put that etag in the request to
 `UpdateRestore` or `DeleteRestore` to ensure that their change will be
 applied to the same version of the resource.
        string etag = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtagBytes in interface RestoreOrBuilder
        Returns:
        The bytes for etag.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Restore getDefaultInstance()

      • parser

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

      • getParserForType

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