Interface RestoreOrBuilder (0.7.0)

Version 0.7.0

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6
• 0.1.0

public interface RestoreOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getBackup()

public abstract 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 abstract 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 abstract 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) = { ... }

Returns

Type	Description
String	The cluster.

getClusterBytes()

public abstract 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) = { ... }

Returns

Type	Description
ByteString	The bytes for cluster.

getCompleteTime()

public abstract 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 abstract TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Timestamp of when the restore operation completed.

.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

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
TimestampOrBuilder

getDescription()

public abstract String getDescription()

User specified descriptive string for this Restore.

string description = 5;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

User specified descriptive string for this Restore.

string description = 5;

Returns

Type	Description
ByteString	The bytes for description.

getEtag()

public abstract 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];

Returns

Type	Description
String	The etag.

getEtagBytes()

public abstract 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.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

A set of custom labels supplied by user.

map<string, string> labels = 9;

Returns

Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

A set of custom labels supplied by user.

map<string, string> labels = 9;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract 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()

public abstract 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 abstract 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.

getResourcesExcludedCount()

public abstract 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 abstract 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 abstract 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 abstract 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];

Returns

Type	Description
RestoreConfig	The restoreConfig.

getRestoreConfigOrBuilder()

public abstract 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];

Returns

Type	Description
RestoreConfigOrBuilder

getState()

public abstract 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];

Returns

Type	Description
Restore.State	The state.

getStateReason()

public abstract 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 abstract 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 abstract 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()

public abstract String 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 abstract 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 abstract 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 abstract 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];

Returns

Type	Description
TimestampOrBuilder

getVolumesRestoredCount()

public abstract 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 abstract 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 abstract 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.

hasRestoreConfig()

public abstract 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 abstract 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.