public static final class UpdateClusterRequest.Builder extends GeneratedMessageV3.Builder<UpdateClusterRequest.Builder> implements UpdateClusterRequestOrBuilderMessage for updating a Cluster
Protobuf type google.cloud.alloydb.v1.UpdateClusterRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateClusterRequest.BuilderImplements
UpdateClusterRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
build()
public UpdateClusterRequest build()| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest |
|
buildPartial()
public UpdateClusterRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest |
|
clear()
public UpdateClusterRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
clearAllowMissing()
public UpdateClusterRequest.Builder clearAllowMissing() Optional. If set to true, update succeeds even if cluster is not found. In
that case, a new cluster is created and update_mask is ignored.
bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
This builder for chaining. |
clearCluster()
public UpdateClusterRequest.Builder clearCluster()Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public UpdateClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
clearRequestId()
public UpdateClusterRequest.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 |
UpdateClusterRequest.Builder |
This builder for chaining. |
clearUpdateMask()
public UpdateClusterRequest.Builder clearUpdateMask()Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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 |
UpdateClusterRequest.Builder |
|
clearValidateOnly()
public UpdateClusterRequest.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 |
UpdateClusterRequest.Builder |
This builder for chaining. |
clone()
public UpdateClusterRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
getAllowMissing()
public boolean getAllowMissing() Optional. If set to true, update succeeds even if cluster is not found. In
that case, a new cluster is created and update_mask is ignored.
bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The allowMissing. |
getCluster()
public Cluster getCluster()Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Cluster |
The cluster. |
getClusterBuilder()
public Cluster.Builder getClusterBuilder()Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
getClusterOrBuilder()
public ClusterOrBuilder getClusterOrBuilder()Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ClusterOrBuilder |
|
getDefaultInstanceForType()
public UpdateClusterRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 Cluster 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 Cluster 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 Cluster 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. |
hasCluster()
public boolean hasCluster()Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cluster field is set. |
hasUpdateMask()
public boolean hasUpdateMask()Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCluster(Cluster value)
public UpdateClusterRequest.Builder mergeCluster(Cluster value)Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Cluster |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
mergeFrom(UpdateClusterRequest other)
public UpdateClusterRequest.Builder mergeFrom(UpdateClusterRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
UpdateClusterRequest |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UpdateClusterRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UpdateClusterRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
mergeUpdateMask(FieldMask value)
public UpdateClusterRequest.Builder mergeUpdateMask(FieldMask value)Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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 |
UpdateClusterRequest.Builder |
|
setAllowMissing(boolean value)
public UpdateClusterRequest.Builder setAllowMissing(boolean value) Optional. If set to true, update succeeds even if cluster is not found. In
that case, a new cluster is created and update_mask is ignored.
bool allow_missing = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe allowMissing to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
This builder for chaining. |
setCluster(Cluster value)
public UpdateClusterRequest.Builder setCluster(Cluster value)Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Cluster |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
setCluster(Cluster.Builder builderForValue)
public UpdateClusterRequest.Builder setCluster(Cluster.Builder builderForValue)Required. The resource being updated
.google.cloud.alloydb.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Cluster.Builder |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UpdateClusterRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
setRequestId(String value)
public UpdateClusterRequest.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 |
StringThe requestId to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public UpdateClusterRequest.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 |
ByteStringThe bytes for requestId to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
|
setUpdateMask(FieldMask value)
public UpdateClusterRequest.Builder setUpdateMask(FieldMask value)Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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 |
UpdateClusterRequest.Builder |
|
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateClusterRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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 |
UpdateClusterRequest.Builder |
|
setValidateOnly(boolean value)
public UpdateClusterRequest.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 |
booleanThe validateOnly to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateClusterRequest.Builder |
This builder for chaining. |