/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/gkebackup/v1/restore.proto
package com.google.cloud.gkebackup.v1;
public interface RestoreOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.gkebackup.v1.Restore)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The full name of the Restore resource.
* Format: projects/*/locations/*/restorePlans/*/restores/*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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];
*
* @return The uid.
*/
java.lang.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];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The timestamp when this Restore resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The timestamp when this Restore resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The timestamp when this Restore resource was last
* updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* User specified descriptive string for this Restore.
*
*
* string description = 5;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* User specified descriptive string for this Restore.
*
*
* string description = 5;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The backup.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for backup.
*/
com.google.protobuf.ByteString getBackupBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The cluster.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for cluster.
*/
com.google.protobuf.ByteString getClusterBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the restoreConfig field is set.
*/
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];
*
*
* @return The restoreConfig.
*/
com.google.cloud.gkebackup.v1.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];
*
*/
com.google.cloud.gkebackup.v1.RestoreConfigOrBuilder getRestoreConfigOrBuilder();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 9;
*/
int getLabelsCount();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 9;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 9;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 9;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 9;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The current state of the Restore.
*
*
*
* .google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The current state of the Restore.
*
*
*
* .google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.gkebackup.v1.Restore.State getState();
/**
*
*
*
* Output only. Human-readable description of why the Restore is in its current state.
*
*
* string state_reason = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The stateReason.
*/
java.lang.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];
*
* @return The bytes for stateReason.
*/
com.google.protobuf.ByteString getStateReasonBytes();
/**
*
*
*
* Output only. Timestamp of when the restore operation completed.
*
*
*
* .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the completeTime field is set.
*/
boolean hasCompleteTime();
/**
*
*
*
* Output only. Timestamp of when the restore operation completed.
*
*
*
* .google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The completeTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder();
/**
*
*
*
* Output only. Number of resources restored during the restore execution.
*
*
* int32 resources_restored_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The resourcesRestoredCount.
*/
int getResourcesRestoredCount();
/**
*
*
*
* Output only. Number of resources excluded during the restore execution.
*
*
* int32 resources_excluded_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The resourcesExcludedCount.
*/
int getResourcesExcludedCount();
/**
*
*
*
* 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];
*
* @return The resourcesFailedCount.
*/
int getResourcesFailedCount();
/**
*
*
*
* Output only. Number of volumes restored during the restore execution.
*
*
* int32 volumes_restored_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The volumesRestoredCount.
*/
int getVolumesRestoredCount();
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
}