Class UpdateUserRequest.Builder (0.35.0)

public static final class UpdateUserRequest.Builder extends GeneratedMessageV3.Builder<UpdateUserRequest.Builder> implements UpdateUserRequestOrBuilder

Message for updating a User

Protobuf type google.cloud.alloydb.v1.UpdateUserRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateUserRequest build()
Returns
Type Description
UpdateUserRequest

buildPartial()

public UpdateUserRequest buildPartial()
Returns
Type Description
UpdateUserRequest

clear()

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

clearAllowMissing()

public UpdateUserRequest.Builder clearAllowMissing()

Optional. Allow missing fields in the update mask.

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

Returns
Type Description
UpdateUserRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

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

This builder for chaining.

clearUpdateMask()

public UpdateUserRequest.Builder clearUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the User 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
UpdateUserRequest.Builder

clearUser()

public UpdateUserRequest.Builder clearUser()

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateUserRequest.Builder

clearValidateOnly()

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

This builder for chaining.

clone()

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

getAllowMissing()

public boolean getAllowMissing()

Optional. Allow missing fields in the update mask.

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

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public UpdateUserRequest getDefaultInstanceForType()
Returns
Type Description
UpdateUserRequest

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 User 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 User 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 User 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

getUser()

public User getUser()

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
User

The user.

getUserBuilder()

public User.Builder getUserBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
User.Builder

getUserOrBuilder()

public UserOrBuilder getUserOrBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UserOrBuilder

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.

hasUpdateMask()

public boolean hasUpdateMask()

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

hasUser()

public boolean hasUser()

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the user field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateUserRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateUserRequest.Builder mergeUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the User 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
UpdateUserRequest.Builder

mergeUser(User value)

public UpdateUserRequest.Builder mergeUser(User value)

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value User
Returns
Type Description
UpdateUserRequest.Builder

setAllowMissing(boolean value)

public UpdateUserRequest.Builder setAllowMissing(boolean value)

Optional. Allow missing fields in the update mask.

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

Parameter
Name Description
value boolean

The allowMissing to set.

Returns
Type Description
UpdateUserRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRequestId(String value)

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

This builder for chaining.

setRequestIdBytes(ByteString value)

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateUserRequest.Builder setUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the User 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
UpdateUserRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateUserRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Optional. Field mask is used to specify the fields to be overwritten in the User 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
UpdateUserRequest.Builder

setUser(User value)

public UpdateUserRequest.Builder setUser(User value)

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value User
Returns
Type Description
UpdateUserRequest.Builder

setUser(User.Builder builderForValue)

public UpdateUserRequest.Builder setUser(User.Builder builderForValue)

Required. The resource being updated

.google.cloud.alloydb.v1.User user = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue User.Builder
Returns
Type Description
UpdateUserRequest.Builder

setValidateOnly(boolean value)

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

This builder for chaining.