Class FindNeighborsResponse.Neighbor.Builder (3.47.0)

public static final class FindNeighborsResponse.Neighbor.Builder extends GeneratedMessageV3.Builder<FindNeighborsResponse.Neighbor.Builder> implements FindNeighborsResponse.NeighborOrBuilder

A neighbor of the query vector.

Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsResponse.Neighbor

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FindNeighborsResponse.Neighbor build()
Returns
Type Description
FindNeighborsResponse.Neighbor

buildPartial()

public FindNeighborsResponse.Neighbor buildPartial()
Returns
Type Description
FindNeighborsResponse.Neighbor

clear()

public FindNeighborsResponse.Neighbor.Builder clear()
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder
Overrides

clearDatapoint()

public FindNeighborsResponse.Neighbor.Builder clearDatapoint()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

clearDistance()

public FindNeighborsResponse.Neighbor.Builder clearDistance()

The distance between the neighbor and the dense embedding query.

double distance = 2;

Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSparseDistance()

public FindNeighborsResponse.Neighbor.Builder clearSparseDistance()

The distance between the neighbor and the query sparse_embedding.

double sparse_distance = 3;

Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

This builder for chaining.

clone()

public FindNeighborsResponse.Neighbor.Builder clone()
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder
Overrides

getDatapoint()

public IndexDatapoint getDatapoint()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapoint

The datapoint.

getDatapointBuilder()

public IndexDatapoint.Builder getDatapointBuilder()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapoint.Builder

getDatapointOrBuilder()

public IndexDatapointOrBuilder getDatapointOrBuilder()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapointOrBuilder

getDefaultInstanceForType()

public FindNeighborsResponse.Neighbor getDefaultInstanceForType()
Returns
Type Description
FindNeighborsResponse.Neighbor

getDescriptorForType()

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

getDistance()

public double getDistance()

The distance between the neighbor and the dense embedding query.

double distance = 2;

Returns
Type Description
double

The distance.

getSparseDistance()

public double getSparseDistance()

The distance between the neighbor and the query sparse_embedding.

double sparse_distance = 3;

Returns
Type Description
double

The sparseDistance.

hasDatapoint()

public boolean hasDatapoint()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
boolean

Whether the datapoint field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDatapoint(IndexDatapoint value)

public FindNeighborsResponse.Neighbor.Builder mergeDatapoint(IndexDatapoint value)

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Parameter
Name Description
value IndexDatapoint
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

mergeFrom(FindNeighborsResponse.Neighbor other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDatapoint(IndexDatapoint value)

public FindNeighborsResponse.Neighbor.Builder setDatapoint(IndexDatapoint value)

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Parameter
Name Description
value IndexDatapoint
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

setDatapoint(IndexDatapoint.Builder builderForValue)

public FindNeighborsResponse.Neighbor.Builder setDatapoint(IndexDatapoint.Builder builderForValue)

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1beta1.IndexDatapoint datapoint = 1;

Parameter
Name Description
builderForValue IndexDatapoint.Builder
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

setDistance(double value)

public FindNeighborsResponse.Neighbor.Builder setDistance(double value)

The distance between the neighbor and the dense embedding query.

double distance = 2;

Parameter
Name Description
value double

The distance to set.

Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSparseDistance(double value)

public FindNeighborsResponse.Neighbor.Builder setSparseDistance(double value)

The distance between the neighbor and the query sparse_embedding.

double sparse_distance = 3;

Parameter
Name Description
value double

The sparseDistance to set.

Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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