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.
Next id: 18
Protobuf type google.cloud.gkebackup.v1.Restore
Static Fields
BACKUP_FIELD_NUMBER
public static final int BACKUP_FIELD_NUMBER
Field Value
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
Field Value
COMPLETE_TIME_FIELD_NUMBER
public static final int COMPLETE_TIME_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER
public static final int RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER
Field Value
RESOURCES_FAILED_COUNT_FIELD_NUMBER
public static final int RESOURCES_FAILED_COUNT_FIELD_NUMBER
Field Value
RESOURCES_RESTORED_COUNT_FIELD_NUMBER
public static final int RESOURCES_RESTORED_COUNT_FIELD_NUMBER
Field Value
RESTORE_CONFIG_FIELD_NUMBER
public static final int RESTORE_CONFIG_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
STATE_REASON_FIELD_NUMBER
public static final int STATE_REASON_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
VOLUMES_RESTORED_COUNT_FIELD_NUMBER
public static final int VOLUMES_RESTORED_COUNT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Restore getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Restore.Builder newBuilder()
Returns
newBuilder(Restore prototype)
public static Restore.Builder newBuilder(Restore prototype)
Parameter
Returns
public static Restore parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Restore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Restore parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Restore parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Restore parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Restore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Restore parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Restore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Restore parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Restore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Restore> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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) = { ... }
| 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) = { ... }
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 value.
string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The cluster.
|
getClusterBytes()
public 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 value.
string cluster = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
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];
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];
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()
Returns
getDescription()
public String getDescription()
User specified descriptive string for this Restore.
string description = 5;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User specified descriptive string for this Restore.
string description = 5;
| 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];
| 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];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
A set of custom labels supplied by user.
map<string, string> labels = 9;
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;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
getName()
Output only. The full name of the Restore resource.
Format: projects/*/locations/*/restorePlans/*/restores/*
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getParserForType()
public Parser<Restore> getParserForType()
Returns
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];
| 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];
| 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];
| 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
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];
| 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];
| 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];
| 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];
getUidBytes()
public ByteString getUidBytes()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the createTime 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Restore.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Restore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Restore.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
