public static final class UpdateIndexRequest.Builder extends GeneratedMessage.Builder<UpdateIndexRequest.Builder> implements UpdateIndexRequestOrBuilderMessage for updating an Index.
Protobuf type google.cloud.vectorsearch.v1.UpdateIndexRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > UpdateIndexRequest.BuilderImplements
UpdateIndexRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public UpdateIndexRequest build()| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest |
|
buildPartial()
public UpdateIndexRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest |
|
clear()
public UpdateIndexRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
clearIndex()
public UpdateIndexRequest.Builder clearIndex()Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
clearRequestId()
public UpdateIndexRequest.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, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
This builder for chaining. |
clearUpdateMask()
public UpdateIndexRequest.Builder clearUpdateMask()Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
getDefaultInstanceForType()
public UpdateIndexRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIndex()
public Index getIndex()Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Index |
The index. |
getIndexBuilder()
public Index.Builder getIndexBuilder()Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Index.Builder |
|
getIndexOrBuilder()
public IndexOrBuilder getIndexOrBuilder()Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
IndexOrBuilder |
|
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, (.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 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, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestId. |
getUpdateMask()
public FieldMask getUpdateMask()Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskBuilder()
public FieldMask.Builder getUpdateMaskBuilder()Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
hasIndex()
public boolean hasIndex()Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the index field is set. |
hasUpdateMask()
public boolean hasUpdateMask()Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(UpdateIndexRequest other)
public UpdateIndexRequest.Builder mergeFrom(UpdateIndexRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
UpdateIndexRequest |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UpdateIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UpdateIndexRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
mergeIndex(Index value)
public UpdateIndexRequest.Builder mergeIndex(Index value)Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
mergeUpdateMask(FieldMask value)
public UpdateIndexRequest.Builder mergeUpdateMask(FieldMask value)Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
setIndex(Index value)
public UpdateIndexRequest.Builder setIndex(Index value)Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
setIndex(Index.Builder builderForValue)
public UpdateIndexRequest.Builder setIndex(Index.Builder builderForValue)Required. The resource being updated.
.google.cloud.vectorsearch.v1.Index index = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Index.Builder |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
setRequestId(String value)
public UpdateIndexRequest.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, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe requestId to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public UpdateIndexRequest.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, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for requestId to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
This builder for chaining. |
setUpdateMask(FieldMask value)
public UpdateIndexRequest.Builder setUpdateMask(FieldMask value)Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateIndexRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)Optional. Specifies the fields to be overwritten in the Index 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 present in the request with non-empty values will be overwritten.
The following fields support update:
display_namedescriptionlabelsdedicated_infrastructure.autoscaling_spec.min_replica_countdedicated_infrastructure.autoscaling_spec.max_replica_countIf
*is provided in theupdate_mask, full replacement of mutable fields will be performed.
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UpdateIndexRequest.Builder |
|