Class UpdateInstanceRequest.Builder (0.37.0)

public static final class UpdateInstanceRequest.Builder extends GeneratedMessageV3.Builder<UpdateInstanceRequest.Builder> implements UpdateInstanceRequestOrBuilder

Message for updating a Instance

Protobuf type google.cloud.alloydb.v1beta.UpdateInstanceRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateInstanceRequest build()
Returns
Type Description
UpdateInstanceRequest

buildPartial()

public UpdateInstanceRequest buildPartial()
Returns
Type Description
UpdateInstanceRequest

clear()

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

clearAllowMissing()

public UpdateInstanceRequest.Builder clearAllowMissing()

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

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

Returns
Type Description
UpdateInstanceRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInstance()

public UpdateInstanceRequest.Builder clearInstance()

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateInstanceRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

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

This builder for chaining.

clearUpdateMask()

public UpdateInstanceRequest.Builder clearUpdateMask()

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

clearValidateOnly()

public UpdateInstanceRequest.Builder clearValidateOnly()

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.

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

Returns
Type Description
UpdateInstanceRequest.Builder

This builder for chaining.

clone()

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

getAllowMissing()

public boolean getAllowMissing()

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

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

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public UpdateInstanceRequest getDefaultInstanceForType()
Returns
Type Description
UpdateInstanceRequest

getDescriptorForType()

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

getInstance()

public Instance getInstance()

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Instance

The instance.

getInstanceBuilder()

public Instance.Builder getInstanceBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Instance.Builder

getInstanceOrBuilder()

public InstanceOrBuilder getInstanceOrBuilder()

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InstanceOrBuilder

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 Instance 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 Instance 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 Instance 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, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.

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

Returns
Type Description
boolean

The validateOnly.

hasInstance()

public boolean hasInstance()

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the instance field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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

mergeFrom(UpdateInstanceRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInstance(Instance value)

public UpdateInstanceRequest.Builder mergeInstance(Instance value)

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Instance
Returns
Type Description
UpdateInstanceRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateInstanceRequest.Builder mergeUpdateMask(FieldMask value)

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

setAllowMissing(boolean value)

public UpdateInstanceRequest.Builder setAllowMissing(boolean value)

Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance 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
UpdateInstanceRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInstance(Instance value)

public UpdateInstanceRequest.Builder setInstance(Instance value)

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Instance
Returns
Type Description
UpdateInstanceRequest.Builder

setInstance(Instance.Builder builderForValue)

public UpdateInstanceRequest.Builder setInstance(Instance.Builder builderForValue)

Required. The resource being updated

.google.cloud.alloydb.v1beta.Instance instance = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Instance.Builder
Returns
Type Description
UpdateInstanceRequest.Builder

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

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

setRequestId(String value)

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

This builder for chaining.

setRequestIdBytes(ByteString value)

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateInstanceRequest.Builder setUpdateMask(FieldMask value)

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

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateInstanceRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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

setValidateOnly(boolean value)

public UpdateInstanceRequest.Builder setValidateOnly(boolean value)

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.

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

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
UpdateInstanceRequest.Builder

This builder for chaining.