Class RestorePlan.Builder (0.54.0) 

public static final class RestorePlan.Builder extends GeneratedMessageV3.Builder<RestorePlan.Builder> implements RestorePlanOrBuilder

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

Protobuf type google.cloud.gkebackup.v1.RestorePlan

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RestorePlan build()
Returns
Type Description
RestorePlan

buildPartial()

public RestorePlan buildPartial()
Returns
Type Description
RestorePlan

clear()

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

clearBackupPlan()

public RestorePlan.Builder clearBackupPlan()

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearCluster()

public RestorePlan.Builder clearCluster()

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearCreateTime()

public RestorePlan.Builder clearCreateTime()

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

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

Returns
Type Description
RestorePlan.Builder

clearDescription()

public RestorePlan.Builder clearDescription()

Optional. User specified descriptive string for this RestorePlan.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearEtag()

public RestorePlan.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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearName()

public RestorePlan.Builder clearName()

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

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

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRestoreConfig()

public RestorePlan.Builder clearRestoreConfig()

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestorePlan.Builder

clearState()

public RestorePlan.Builder clearState()

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

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

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearStateReason()

public RestorePlan.Builder clearStateReason()

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

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

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearUid()

public RestorePlan.Builder clearUid()

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

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

Returns
Type Description
RestorePlan.Builder

This builder for chaining.

clearUpdateTime()

public RestorePlan.Builder clearUpdateTime()

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

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

Returns
Type Description
RestorePlan.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getBackupPlan()

public String getBackupPlan()

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backupPlan.

getBackupPlanBytes()

public ByteString getBackupPlanBytes()

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backupPlan.

getCluster()

public String getCluster()

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The cluster.

getClusterBytes()

public ByteString getClusterBytes()

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for cluster.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when this RestorePlan 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 RestorePlan 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 RestorePlan resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public RestorePlan getDefaultInstanceForType()
Returns
Type Description
RestorePlan

getDescription()

public String getDescription()

Optional. User specified descriptive string for this RestorePlan.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User specified descriptive string for this RestorePlan.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.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()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

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 RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

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 RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

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

Returns
Type Description
ByteString

The bytes for name.

getRestoreConfig()

public RestoreConfig getRestoreConfig()

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreConfig

The restoreConfig.

getRestoreConfigBuilder()

public RestoreConfig.Builder getRestoreConfigBuilder()

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreConfig.Builder

getRestoreConfigOrBuilder()

public RestoreConfigOrBuilder getRestoreConfigOrBuilder()

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreConfigOrBuilder

getState()

public RestorePlan.State getState()

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

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

Returns
Type Description
RestorePlan.State

The state.

getStateReason()

public String getStateReason()

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

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

Returns
Type Description
String

The stateReason.

getStateReasonBytes()

public ByteString getStateReasonBytes()

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

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

Returns
Type Description
ByteString

The bytes for stateReason.

getStateValue()

public int getStateValue()

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

.google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.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 RestorePlan 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 RestorePlan 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 RestorePlan resource was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when this RestorePlan 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()

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the restoreConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this RestorePlan 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

mergeCreateTime(Timestamp value)

public RestorePlan.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestorePlan.Builder

mergeFrom(RestorePlan other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRestoreConfig(RestoreConfig value)

public RestorePlan.Builder mergeRestoreConfig(RestoreConfig value)

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value RestoreConfig
Returns
Type Description
RestorePlan.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public RestorePlan.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestorePlan.Builder

putAllLabels(Map<String,String> values)

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

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

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

putLabels(String key, String value)

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

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

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

removeLabels(String key)

public RestorePlan.Builder removeLabels(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
RestorePlan.Builder

setBackupPlan(String value)

public RestorePlan.Builder setBackupPlan(String value)

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The backupPlan to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setBackupPlanBytes(ByteString value)

public RestorePlan.Builder setBackupPlanBytes(ByteString value)

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for backupPlan to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setCluster(String value)

public RestorePlan.Builder setCluster(String value)

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The cluster to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setClusterBytes(ByteString value)

public RestorePlan.Builder setClusterBytes(ByteString value)

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*

string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

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

This builder for chaining.

setCreateTime(Timestamp value)

public RestorePlan.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestorePlan.Builder

setCreateTime(Timestamp.Builder builderForValue)

public RestorePlan.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestorePlan.Builder

setDescription(String value)

public RestorePlan.Builder setDescription(String value)

Optional. User specified descriptive string for this RestorePlan.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public RestorePlan.Builder setDescriptionBytes(ByteString value)

Optional. User specified descriptive string for this RestorePlan.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setEtag(String value)

public RestorePlan.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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public RestorePlan.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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public RestorePlan.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RestorePlan.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

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

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

setRestoreConfig(RestoreConfig value)

public RestorePlan.Builder setRestoreConfig(RestoreConfig value)

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value RestoreConfig
Returns
Type Description
RestorePlan.Builder

setRestoreConfig(RestoreConfig.Builder builderForValue)

public RestorePlan.Builder setRestoreConfig(RestoreConfig.Builder builderForValue)

Required. Configuration of Restores created via this RestorePlan.

.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];

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

setState(RestorePlan.State value)

public RestorePlan.Builder setState(RestorePlan.State value)

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

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

Parameter
Name Description
value RestorePlan.State

The state to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setStateReason(String value)

public RestorePlan.Builder setStateReason(String value)

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

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

Parameter
Name Description
value String

The stateReason to set.
Returns
Type Description
RestorePlan.Builder

This builder for chaining.

setStateReasonBytes(ByteString value)

public RestorePlan.Builder setStateReasonBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setStateValue(int value)

public RestorePlan.Builder setStateValue(int value)

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

.google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.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
RestorePlan.Builder

This builder for chaining.

setUid(String value)

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

This builder for chaining.

setUidBytes(ByteString value)

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public RestorePlan.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestorePlan.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public RestorePlan.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestorePlan.Builder