- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class FindNeighborsRequest.Builder extends GeneratedMessageV3.Builder<FindNeighborsRequest.Builder> implements FindNeighborsRequestOrBuilderThe request message for MatchService.FindNeighbors.
Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FindNeighborsRequest.BuilderImplements
FindNeighborsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllQueries(Iterable<? extends FindNeighborsRequest.Query> values)
public FindNeighborsRequest.Builder addAllQueries(Iterable<? extends FindNeighborsRequest.Query> values)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query> |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
addQueries(FindNeighborsRequest.Query value)
public FindNeighborsRequest.Builder addQueries(FindNeighborsRequest.Query value)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
FindNeighborsRequest.Query |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
addQueries(FindNeighborsRequest.Query.Builder builderForValue)
public FindNeighborsRequest.Builder addQueries(FindNeighborsRequest.Query.Builder builderForValue)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FindNeighborsRequest.Query.Builder |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
addQueries(int index, FindNeighborsRequest.Query value)
public FindNeighborsRequest.Builder addQueries(int index, FindNeighborsRequest.Query value)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
FindNeighborsRequest.Query |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
addQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)
public FindNeighborsRequest.Builder addQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
FindNeighborsRequest.Query.Builder |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
addQueriesBuilder()
public FindNeighborsRequest.Query.Builder addQueriesBuilder()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Query.Builder |
|
addQueriesBuilder(int index)
public FindNeighborsRequest.Query.Builder addQueriesBuilder(int index)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Query.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FindNeighborsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
build()
public FindNeighborsRequest build()| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest |
|
buildPartial()
public FindNeighborsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest |
|
clear()
public FindNeighborsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
clearDeployedIndexId()
public FindNeighborsRequest.Builder clearDeployedIndexId()The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
string deployed_index_id = 2;
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public FindNeighborsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
clearIndexEndpoint()
public FindNeighborsRequest.Builder clearIndexEndpoint() Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public FindNeighborsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
clearQueries()
public FindNeighborsRequest.Builder clearQueries()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
clearReturnFullDatapoint()
public FindNeighborsRequest.Builder clearReturnFullDatapoint()If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.
bool return_full_datapoint = 4;
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
clone()
public FindNeighborsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
getDefaultInstanceForType()
public FindNeighborsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest |
|
getDeployedIndexId()
public String getDeployedIndexId()The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
string deployed_index_id = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The deployedIndexId. |
getDeployedIndexIdBytes()
public ByteString getDeployedIndexIdBytes()The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
string deployed_index_id = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for deployedIndexId. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIndexEndpoint()
public String getIndexEndpoint() Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The indexEndpoint. |
getIndexEndpointBytes()
public ByteString getIndexEndpointBytes() Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for indexEndpoint. |
getQueries(int index)
public FindNeighborsRequest.Query getQueries(int index)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Query |
|
getQueriesBuilder(int index)
public FindNeighborsRequest.Query.Builder getQueriesBuilder(int index)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Query.Builder |
|
getQueriesBuilderList()
public List<FindNeighborsRequest.Query.Builder> getQueriesBuilderList()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getQueriesCount()
public int getQueriesCount()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getQueriesList()
public List<FindNeighborsRequest.Query> getQueriesList()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
List<Query> |
|
getQueriesOrBuilder(int index)
public FindNeighborsRequest.QueryOrBuilder getQueriesOrBuilder(int index)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.QueryOrBuilder |
|
getQueriesOrBuilderList()
public List<? extends FindNeighborsRequest.QueryOrBuilder> getQueriesOrBuilderList()The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.QueryOrBuilder> |
|
getReturnFullDatapoint()
public boolean getReturnFullDatapoint()If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.
bool return_full_datapoint = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
The returnFullDatapoint. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(FindNeighborsRequest other)
public FindNeighborsRequest.Builder mergeFrom(FindNeighborsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
FindNeighborsRequest |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FindNeighborsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public FindNeighborsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FindNeighborsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
removeQueries(int index)
public FindNeighborsRequest.Builder removeQueries(int index)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
setDeployedIndexId(String value)
public FindNeighborsRequest.Builder setDeployedIndexId(String value)The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
string deployed_index_id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe deployedIndexId to set. |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
setDeployedIndexIdBytes(ByteString value)
public FindNeighborsRequest.Builder setDeployedIndexIdBytes(ByteString value)The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.
string deployed_index_id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for deployedIndexId to set. |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public FindNeighborsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
setIndexEndpoint(String value)
public FindNeighborsRequest.Builder setIndexEndpoint(String value) Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe indexEndpoint to set. |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
setIndexEndpointBytes(ByteString value)
public FindNeighborsRequest.Builder setIndexEndpointBytes(ByteString value) Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for indexEndpoint to set. |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
setQueries(int index, FindNeighborsRequest.Query value)
public FindNeighborsRequest.Builder setQueries(int index, FindNeighborsRequest.Query value)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
FindNeighborsRequest.Query |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
setQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)
public FindNeighborsRequest.Builder setQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
FindNeighborsRequest.Query.Builder |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FindNeighborsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|
setReturnFullDatapoint(boolean value)
public FindNeighborsRequest.Builder setReturnFullDatapoint(boolean value)If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.
bool return_full_datapoint = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe returnFullDatapoint to set. |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final FindNeighborsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FindNeighborsRequest.Builder |
|