Class FindNeighborsResponse.Neighbor.Builder (3.56.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.v1.FindNeighborsResponse.Neighbor

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FindNeighborsResponse.Neighbor.Builder

Implements

FindNeighborsResponse.NeighborOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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.v1.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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public FindNeighborsResponse.Neighbor.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`FindNeighborsResponse.Neighbor.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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.v1.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.v1.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.v1.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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.v1.IndexDatapoint datapoint = 1;

Returns
Type	Description
`boolean`	Whether the datapoint field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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.v1.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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsResponse.Neighbor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`FindNeighborsResponse.Neighbor.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.v1.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.v1.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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)