Class UpdateBackupRequest.Builder (0.36.0)

public static final class UpdateBackupRequest.Builder extends GeneratedMessageV3.Builder<UpdateBackupRequest.Builder> implements UpdateBackupRequestOrBuilder

Message for updating a Backup

Protobuf type google.cloud.alloydb.v1.UpdateBackupRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateBackupRequest build()
Returns
Type Description
UpdateBackupRequest

buildPartial()

public UpdateBackupRequest buildPartial()
Returns
Type Description
UpdateBackupRequest

clear()

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

clearAllowMissing()

public UpdateBackupRequest.Builder clearAllowMissing()

Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and update_mask is ignored.

bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

clearBackup()

public UpdateBackupRequest.Builder clearBackup()

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateBackupRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

public UpdateBackupRequest.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 the 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];

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateBackupRequest.Builder clearUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateBackupRequest.Builder

clearValidateOnly()

public UpdateBackupRequest.Builder clearValidateOnly()

Optional. If set, the backend validates the request, but doesn't actually execute it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

clone()

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

getAllowMissing()

public boolean getAllowMissing()

Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and update_mask is ignored.

bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allowMissing.

getBackup()

public Backup getBackup()

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Backup

The backup.

getBackupBuilder()

public Backup.Builder getBackupBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Backup.Builder

getBackupOrBuilder()

public BackupOrBuilder getBackupOrBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupOrBuilder

getDefaultInstanceForType()

public UpdateBackupRequest getDefaultInstanceForType()
Returns
Type Description
UpdateBackupRequest

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

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

Returns
Type Description
ByteString

The bytes for requestId.

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, the backend validates the request, but doesn't actually execute it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasBackup()

public boolean hasBackup()

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backup field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

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

mergeBackup(Backup value)

public UpdateBackupRequest.Builder mergeBackup(Backup value)

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Backup
Returns
Type Description
UpdateBackupRequest.Builder

mergeFrom(UpdateBackupRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateBackupRequest.Builder mergeUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateBackupRequest.Builder

setAllowMissing(boolean value)

public UpdateBackupRequest.Builder setAllowMissing(boolean value)

Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and update_mask is ignored.

bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The allowMissing to set.

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

setBackup(Backup value)

public UpdateBackupRequest.Builder setBackup(Backup value)

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Backup
Returns
Type Description
UpdateBackupRequest.Builder

setBackup(Backup.Builder builderForValue)

public UpdateBackupRequest.Builder setBackup(Backup.Builder builderForValue)

Required. The resource being updated

.google.cloud.alloydb.v1.Backup backup = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Backup.Builder
Returns
Type Description
UpdateBackupRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRequestId(String value)

public UpdateBackupRequest.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 the 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];

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateBackupRequest.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 the 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];

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateBackupRequest.Builder setUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateBackupRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateBackupRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Optional. Field mask is used to specify the fields to be overwritten in the Backup 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 all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateBackupRequest.Builder

setValidateOnly(boolean value)

public UpdateBackupRequest.Builder setValidateOnly(boolean value)

Optional. If set, the backend validates the request, but doesn't actually execute it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
UpdateBackupRequest.Builder

This builder for chaining.