Class Restore.Builder (0.41.0) 

public static final class Restore.Builder extends GeneratedMessageV3.Builder<Restore.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Restore.Builder

Implements

RestoreOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Restore.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Restore.Builder
Overrides

build()

public Restore build()
Returns
Type Description
Restore

buildPartial()

public Restore buildPartial()
Returns
Type Description
Restore

clear()

public Restore.Builder clear()
Returns
Type Description
Restore.Builder
Overrides

clearBackup()

public Restore.Builder clearBackup()

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
Restore.Builder

This builder for chaining.

clearCluster()

public Restore.Builder clearCluster()

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
Restore.Builder

This builder for chaining.

clearCompleteTime()

public Restore.Builder clearCompleteTime()

Output only. Timestamp of when the restore operation completed.

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

Returns
Type Description
Restore.Builder

clearCreateTime()

public Restore.Builder clearCreateTime()

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
Restore.Builder

clearDescription()

public Restore.Builder clearDescription()

User specified descriptive string for this Restore.

string description = 5;

Returns
Type Description
Restore.Builder

This builder for chaining.

clearEtag()

public Restore.Builder clearEtag()

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
Restore.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Restore.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Restore.Builder
Overrides

clearLabels()

public Restore.Builder clearLabels()
Returns
Type Description
Restore.Builder

clearName()

public Restore.Builder clearName()

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
Restore.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Restore.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Restore.Builder
Overrides

clearResourcesExcludedCount()

public Restore.Builder clearResourcesExcludedCount()

Output only. Number of resources excluded during the restore execution.

int32 resources_excluded_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Restore.Builder

This builder for chaining.

clearResourcesFailedCount()

public Restore.Builder clearResourcesFailedCount()

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
Restore.Builder

This builder for chaining.

clearResourcesRestoredCount()

public Restore.Builder clearResourcesRestoredCount()

Output only. Number of resources restored during the restore execution.

int32 resources_restored_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Restore.Builder

This builder for chaining.

clearRestoreConfig()

public Restore.Builder clearRestoreConfig()

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
Restore.Builder

clearState()

public Restore.Builder clearState()

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.Builder

This builder for chaining.

clearStateReason()

public Restore.Builder clearStateReason()

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
Restore.Builder

This builder for chaining.

clearUid()

public Restore.Builder clearUid()

Output only. Server generated global unique identifier of UUID format.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Restore.Builder

This builder for chaining.

clearUpdateTime()

public Restore.Builder clearUpdateTime()

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
Restore.Builder

clearVolumesRestoredCount()

public Restore.Builder clearVolumesRestoredCount()

Output only. Number of volumes restored during the restore execution.

int32 volumes_restored_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Restore.Builder

This builder for chaining.

clone()

public Restore.Builder clone()
Returns
Type Description
Restore.Builder
Overrides

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
Returns
Type Description
boolean

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:

  • 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 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 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.

getCompleteTimeBuilder()

public Timestamp.Builder getCompleteTimeBuilder()

Output only. Timestamp of when the restore operation completed.

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

Returns
Type Description
Builder

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

Returns
Type Description
TimestampOrBuilder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Restore getDefaultInstanceForType()
Returns
Type Description
Restore

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

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.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

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;

Returns
Type Description
Map<String,String>

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;

Parameters
Name Description
key String
defaultValue String
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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

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.

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

Returns
Type Description
RestoreConfig

The restoreConfig.

getRestoreConfigBuilder()

public RestoreConfig.Builder getRestoreConfigBuilder()

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.Builder

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

Returns
Type Description
RestoreConfigOrBuilder

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

Returns
Type Description
Restore.State

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

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

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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

Returns
Type Description
TimestampOrBuilder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompleteTime(Timestamp value)

public Restore.Builder mergeCompleteTime(Timestamp value)

Output only. Timestamp of when the restore operation completed.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

mergeCreateTime(Timestamp value)

public Restore.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

mergeFrom(Restore other)

public Restore.Builder mergeFrom(Restore other)
Parameter
Name Description
other Restore
Returns
Type Description
Restore.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Restore.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Restore.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Restore.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Restore.Builder
Overrides

mergeRestoreConfig(RestoreConfig value)

public Restore.Builder mergeRestoreConfig(RestoreConfig value)

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

Parameter
Name Description
value RestoreConfig
Returns
Type Description
Restore.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Restore.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Restore.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Restore.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

putAllLabels(Map<String,String> values)

public Restore.Builder putAllLabels(Map<String,String> values)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Restore.Builder

putLabels(String key, String value)

public Restore.Builder putLabels(String key, String value)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameters
Name Description
key String
value String
Returns
Type Description
Restore.Builder

removeLabels(String key)

public Restore.Builder removeLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
Restore.Builder

setBackup(String value)

public Restore.Builder setBackup(String value)

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

Parameter
Name Description
value String

The backup to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setBackupBytes(ByteString value)

public Restore.Builder setBackupBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for backup to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setCluster(String value)

public Restore.Builder setCluster(String value)

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

Parameter
Name Description
value String

The cluster to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setClusterBytes(ByteString value)

public Restore.Builder setClusterBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for cluster to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setCompleteTime(Timestamp value)

public Restore.Builder setCompleteTime(Timestamp value)

Output only. Timestamp of when the restore operation completed.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

setCompleteTime(Timestamp.Builder builderForValue)

public Restore.Builder setCompleteTime(Timestamp.Builder builderForValue)

Output only. Timestamp of when the restore operation completed.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Restore.Builder

setCreateTime(Timestamp value)

public Restore.Builder setCreateTime(Timestamp value)

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Restore.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Restore.Builder

setDescription(String value)

public Restore.Builder setDescription(String value)

User specified descriptive string for this Restore.

string description = 5;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Restore.Builder setDescriptionBytes(ByteString value)

User specified descriptive string for this Restore.

string description = 5;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setEtag(String value)

public Restore.Builder setEtag(String value)

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

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Restore.Builder setEtagBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Restore.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Restore.Builder
Overrides

setName(String value)

public Restore.Builder setName(String value)

Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Restore.Builder setNameBytes(ByteString value)

Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Restore.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Restore.Builder
Overrides

setResourcesExcludedCount(int value)

public Restore.Builder setResourcesExcludedCount(int value)

Output only. Number of resources excluded during the restore execution.

int32 resources_excluded_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The resourcesExcludedCount to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setResourcesFailedCount(int value)

public Restore.Builder setResourcesFailedCount(int value)

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

Parameter
Name Description
value int

The resourcesFailedCount to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setResourcesRestoredCount(int value)

public Restore.Builder setResourcesRestoredCount(int value)

Output only. Number of resources restored during the restore execution.

int32 resources_restored_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The resourcesRestoredCount to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setRestoreConfig(RestoreConfig value)

public Restore.Builder setRestoreConfig(RestoreConfig value)

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

Parameter
Name Description
value RestoreConfig
Returns
Type Description
Restore.Builder

setRestoreConfig(RestoreConfig.Builder builderForValue)

public Restore.Builder setRestoreConfig(RestoreConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue RestoreConfig.Builder
Returns
Type Description
Restore.Builder

setState(Restore.State value)

public Restore.Builder setState(Restore.State value)

Output only. The current state of the Restore.

.google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Restore.State

The state to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setStateReason(String value)

public Restore.Builder setStateReason(String value)

Output only. Human-readable description of why the Restore is in its current state.

string state_reason = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The stateReason to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setStateReasonBytes(ByteString value)

public Restore.Builder setStateReasonBytes(ByteString value)

Output only. Human-readable description of why the Restore is in its current state.

string state_reason = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for stateReason to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setStateValue(int value)

public Restore.Builder setStateValue(int value)

Output only. The current state of the Restore.

.google.cloud.gkebackup.v1.Restore.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setUid(String value)

public Restore.Builder setUid(String value)

Output only. Server generated global unique identifier of UUID format.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Restore.Builder setUidBytes(ByteString value)

Output only. Server generated global unique identifier of UUID format.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
Restore.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Restore.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Restore.Builder
Overrides

setUpdateTime(Timestamp value)

public Restore.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Restore.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Restore.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Restore.Builder

setVolumesRestoredCount(int value)

public Restore.Builder setVolumesRestoredCount(int value)

Output only. Number of volumes restored during the restore execution.

int32 volumes_restored_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The volumesRestoredCount to set.
Returns
Type Description
Restore.Builder

This builder for chaining.