Class UpdateBackupPlanRequest.Builder (0.29.0)

public static final class UpdateBackupPlanRequest.Builder extends GeneratedMessageV3.Builder<UpdateBackupPlanRequest.Builder> implements UpdateBackupPlanRequestOrBuilder

Request message for updating a backup plan.

Protobuf type google.cloud.backupdr.v1.UpdateBackupPlanRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateBackupPlanRequest build()
Returns
Type Description
UpdateBackupPlanRequest

buildPartial()

public UpdateBackupPlanRequest buildPartial()
Returns
Type Description
UpdateBackupPlanRequest

clear()

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

clearBackupPlan()

public UpdateBackupPlanRequest.Builder clearBackupPlan()

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateBackupPlanRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

public UpdateBackupPlanRequest.Builder clearRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
UpdateBackupPlanRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateBackupPlanRequest.Builder clearUpdateMask()

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateBackupPlanRequest.Builder

clone()

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

getBackupPlan()

public BackupPlan getBackupPlan()

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupPlan

The backupPlan.

getBackupPlanBuilder()

public BackupPlan.Builder getBackupPlanBuilder()

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupPlan.Builder

getBackupPlanOrBuilder()

public BackupPlanOrBuilder getBackupPlanOrBuilder()

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupPlanOrBuilder

getDefaultInstanceForType()

public UpdateBackupPlanRequest getDefaultInstanceForType()
Returns
Type Description
UpdateBackupPlanRequest

getDescriptorForType()

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

getRequestId()

public String getRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

getUpdateMask()

public FieldMask getUpdateMask()

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMaskOrBuilder

hasBackupPlan()

public boolean hasBackupPlan()

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backupPlan field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackupPlan(BackupPlan value)

public UpdateBackupPlanRequest.Builder mergeBackupPlan(BackupPlan value)

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BackupPlan
Returns
Type Description
UpdateBackupPlanRequest.Builder

mergeFrom(UpdateBackupPlanRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateBackupPlanRequest.Builder mergeUpdateMask(FieldMask value)

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateBackupPlanRequest.Builder

setBackupPlan(BackupPlan value)

public UpdateBackupPlanRequest.Builder setBackupPlan(BackupPlan value)

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BackupPlan
Returns
Type Description
UpdateBackupPlanRequest.Builder

setBackupPlan(BackupPlan.Builder builderForValue)

public UpdateBackupPlanRequest.Builder setBackupPlan(BackupPlan.Builder builderForValue)

Required. The resource being updated

.google.cloud.backupdr.v1.BackupPlan backup_plan = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue BackupPlan.Builder
Returns
Type Description
UpdateBackupPlanRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRequestId(String value)

public UpdateBackupPlanRequest.Builder setRequestId(String value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
UpdateBackupPlanRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateBackupPlanRequest.Builder setRequestIdBytes(ByteString value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
UpdateBackupPlanRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateBackupPlanRequest.Builder setUpdateMask(FieldMask value)

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateBackupPlanRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateBackupPlanRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateBackupPlanRequest.Builder