public final class Restore extends 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.
Protobuf type google.cloud.gkebackup.v1.Restore
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BACKUP_FIELD_NUMBER
public static final int BACKUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMPLETE_TIME_FIELD_NUMBER
public static final int COMPLETE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER
public static final int RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCES_FAILED_COUNT_FIELD_NUMBER
public static final int RESOURCES_FAILED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCES_RESTORED_COUNT_FIELD_NUMBER
public static final int RESOURCES_RESTORED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESTORE_CONFIG_FIELD_NUMBER
public static final int RESTORE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_REASON_FIELD_NUMBER
public static final int STATE_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VOLUMES_RESTORED_COUNT_FIELD_NUMBER
public static final int VOLUMES_RESTORED_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VOLUME_DATA_RESTORE_POLICY_OVERRIDES_FIELD_NUMBER
public static final int VOLUME_DATA_RESTORE_POLICY_OVERRIDES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Restore getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Restore.Builder newBuilder()
newBuilder(Restore prototype)
public static Restore.Builder newBuilder(Restore prototype)
| Parameter |
| Name |
Description |
prototype |
Restore
|
public static Restore parseDelimitedFrom(InputStream input)
public static Restore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Restore parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Restore parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(CodedInputStream input)
public static Restore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(InputStream input)
public static Restore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Restore parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Restore> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackup()
public String getBackup()
Required. Immutable. A reference to the
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. Format:
projects/*/locations/*/backupPlans/*/backups/*.
string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The backup.
|
getBackupBytes()
public ByteString getBackupBytes()
Required. Immutable. A reference to the
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. Format:
projects/*/locations/*/backupPlans/*/backups/*.
string backup = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for backup.
|
getCluster()
public String getCluster()
Output only. The target cluster into which this Restore will restore data.
Valid formats:
string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The cluster.
|
getClusterBytes()
public ByteString getClusterBytes()
Output only. The target cluster into which this Restore will restore data.
Valid formats:
string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for cluster.
|
getCompleteTime()
public Timestamp getCompleteTime()
Output only. Timestamp of when the restore operation completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The completeTime.
|
getCompleteTimeOrBuilder()
public TimestampOrBuilder getCompleteTimeOrBuilder()
Output only. Timestamp of when the restore operation completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when this Restore resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this Restore resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Restore getDefaultInstanceForType()
getDescription()
public String getDescription()
User specified descriptive string for this Restore.
string description = 5;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User specified descriptive string for this Restore.
string description = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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];
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getFilter()
public Restore.Filter getFilter()
Optional. Immutable. Filters resources for Restore. If not specified, the
scope of the restore will remain the same as defined in the RestorePlan.
If this is specified, and no resources are matched by the
inclusion_filters or everyting is excluded by the exclusion_filters,
nothing will be restored. This filter can only be specified if the value of
namespaced_resource_restore_mode
is set to MERGE_SKIP_ON_CONFLICT, MERGE_REPLACE_VOLUME_ON_CONFLICT or
MERGE_REPLACE_ON_CONFLICT.
.google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getFilterOrBuilder()
public Restore.FilterOrBuilder getFilterOrBuilder()
Optional. Immutable. Filters resources for Restore. If not specified, the
scope of the restore will remain the same as defined in the RestorePlan.
If this is specified, and no resources are matched by the
inclusion_filters or everyting is excluded by the exclusion_filters,
nothing will be restored. This filter can only be specified if the value of
namespaced_resource_restore_mode
is set to MERGE_SKIP_ON_CONFLICT, MERGE_REPLACE_VOLUME_ON_CONFLICT or
MERGE_REPLACE_ON_CONFLICT.
.google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
A set of custom labels supplied by user.
map<string, string> labels = 9;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
A set of custom labels supplied by user.
map<string, string> labels = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
A set of custom labels supplied by user.
map<string, string> labels = 9;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Restore> getParserForType()
Overrides
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];
| Returns |
| Type |
Description |
int |
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];
| Returns |
| Type |
Description |
int |
The resourcesFailedCount.
|
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];
| Returns |
| Type |
Description |
int |
The resourcesRestoredCount.
|
getRestoreConfig()
public RestoreConfig getRestoreConfig()
Output only. Configuration of the Restore. Inherited from parent
RestorePlan's
restore_config.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRestoreConfigOrBuilder()
public RestoreConfigOrBuilder getRestoreConfigOrBuilder()
Output only. Configuration of the Restore. Inherited from parent
RestorePlan's
restore_config.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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];
| Returns |
| Type |
Description |
String |
The stateReason.
|
getStateReasonBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for stateReason.
|
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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUid()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for uid.
|
getUpdateTime()
public 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];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public 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];
getVolumeDataRestorePolicyOverrides(int index)
public VolumeDataRestorePolicyOverride getVolumeDataRestorePolicyOverrides(int index)
Optional. Immutable. Overrides the volume data restore policies selected in
the Restore Config for override-scoped resources.
repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getVolumeDataRestorePolicyOverridesCount()
public int getVolumeDataRestorePolicyOverridesCount()
Optional. Immutable. Overrides the volume data restore policies selected in
the Restore Config for override-scoped resources.
repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getVolumeDataRestorePolicyOverridesList()
public List<VolumeDataRestorePolicyOverride> getVolumeDataRestorePolicyOverridesList()
Optional. Immutable. Overrides the volume data restore policies selected in
the Restore Config for override-scoped resources.
repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getVolumeDataRestorePolicyOverridesOrBuilder(int index)
public VolumeDataRestorePolicyOverrideOrBuilder getVolumeDataRestorePolicyOverridesOrBuilder(int index)
Optional. Immutable. Overrides the volume data restore policies selected in
the Restore Config for override-scoped resources.
repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getVolumeDataRestorePolicyOverridesOrBuilderList()
public List<? extends VolumeDataRestorePolicyOverrideOrBuilder> getVolumeDataRestorePolicyOverridesOrBuilderList()
Optional. Immutable. Overrides the volume data restore policies selected in
the Restore Config for override-scoped resources.
repeated .google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverride volume_data_restore_policy_overrides = 19 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.gkebackup.v1.VolumeDataRestorePolicyOverrideOrBuilder> |
|
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];
| Returns |
| Type |
Description |
int |
The volumesRestoredCount.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the completeTime field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasFilter()
public boolean hasFilter()
Optional. Immutable. Filters resources for Restore. If not specified, the
scope of the restore will remain the same as defined in the RestorePlan.
If this is specified, and no resources are matched by the
inclusion_filters or everyting is excluded by the exclusion_filters,
nothing will be restored. This filter can only be specified if the value of
namespaced_resource_restore_mode
is set to MERGE_SKIP_ON_CONFLICT, MERGE_REPLACE_VOLUME_ON_CONFLICT or
MERGE_REPLACE_ON_CONFLICT.
.google.cloud.gkebackup.v1.Restore.Filter filter = 18 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the filter field is set.
|
hasRestoreConfig()
public boolean hasRestoreConfig()
Output only. Configuration of the Restore. Inherited from parent
RestorePlan's
restore_config.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the restoreConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Restore.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Restore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Restore.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
