com.google.cloud.aiplatform.v1

Class NearestNeighbors.Neighbor.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>

com.google.cloud.aiplatform.v1.NearestNeighbors.Neighbor.Builder

All Implemented Interfaces:

NearestNeighbors.NeighborOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

NearestNeighbors.Neighbor

public static final class NearestNeighbors.Neighbor.Builder
extends com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>
implements NearestNeighbors.NeighborOrBuilder

 A neighbor of the query vector.
 

Protobuf type google.cloud.aiplatform.v1.NearestNeighbors.Neighbor

Method Summary

Modifier and Type	Method and Description
NearestNeighbors.Neighbor	build()
NearestNeighbors.Neighbor	buildPartial()
NearestNeighbors.Neighbor.Builder	clear()
NearestNeighbors.Neighbor.Builder	clearDistance() The distance between the neighbor and the query vector.
NearestNeighbors.Neighbor.Builder	clearEntityId() The id of the similar entity.
NearestNeighbors.Neighbor.Builder	clearEntityKeyValues() The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
NearestNeighbors.Neighbor	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getDistance() The distance between the neighbor and the query vector.
String	getEntityId() The id of the similar entity.
com.google.protobuf.ByteString	getEntityIdBytes() The id of the similar entity.
FetchFeatureValuesResponse	getEntityKeyValues() The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
FetchFeatureValuesResponse.Builder	getEntityKeyValuesBuilder() The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
FetchFeatureValuesResponseOrBuilder	getEntityKeyValuesOrBuilder() The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
boolean	hasEntityKeyValues() The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
NearestNeighbors.Neighbor.Builder	mergeEntityKeyValues(FetchFeatureValuesResponse value) The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
NearestNeighbors.Neighbor.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
NearestNeighbors.Neighbor.Builder	mergeFrom(com.google.protobuf.Message other)
NearestNeighbors.Neighbor.Builder	mergeFrom(NearestNeighbors.Neighbor other)
NearestNeighbors.Neighbor.Builder	setDistance(double value) The distance between the neighbor and the query vector.
NearestNeighbors.Neighbor.Builder	setEntityId(String value) The id of the similar entity.
NearestNeighbors.Neighbor.Builder	setEntityIdBytes(com.google.protobuf.ByteString value) The id of the similar entity.
NearestNeighbors.Neighbor.Builder	setEntityKeyValues(FetchFeatureValuesResponse.Builder builderForValue) The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.
NearestNeighbors.Neighbor.Builder	setEntityKeyValues(FetchFeatureValuesResponse value) The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>

clear

public NearestNeighbors.Neighbor.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>

getDefaultInstanceForType

public NearestNeighbors.Neighbor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public NearestNeighbors.Neighbor build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public NearestNeighbors.Neighbor buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public NearestNeighbors.Neighbor.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<NearestNeighbors.Neighbor.Builder>

mergeFrom

public NearestNeighbors.Neighbor.Builder mergeFrom(NearestNeighbors.Neighbor other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<NearestNeighbors.Neighbor.Builder>

mergeFrom

public NearestNeighbors.Neighbor.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<NearestNeighbors.Neighbor.Builder>

Throws:

IOException

getEntityId

public String getEntityId()

 The id of the similar entity.
 

string entity_id = 1;

Specified by:

getEntityId in interface NearestNeighbors.NeighborOrBuilder

Returns:

The entityId.

getEntityIdBytes

public com.google.protobuf.ByteString getEntityIdBytes()

 The id of the similar entity.
 

string entity_id = 1;

Specified by:

getEntityIdBytes in interface NearestNeighbors.NeighborOrBuilder

Returns:

The bytes for entityId.

setEntityId

public NearestNeighbors.Neighbor.Builder setEntityId(String value)

 The id of the similar entity.
 

string entity_id = 1;

Parameters:

value - The entityId to set.

Returns:

This builder for chaining.

clearEntityId

public NearestNeighbors.Neighbor.Builder clearEntityId()

 The id of the similar entity.
 

string entity_id = 1;

Returns:

This builder for chaining.

setEntityIdBytes

public NearestNeighbors.Neighbor.Builder setEntityIdBytes(com.google.protobuf.ByteString value)

 The id of the similar entity.
 

string entity_id = 1;

Parameters:

value - The bytes for entityId to set.

Returns:

This builder for chaining.

getDistance

public double getDistance()

 The distance between the neighbor and the query vector.
 

double distance = 2;

Specified by:

getDistance in interface NearestNeighbors.NeighborOrBuilder

Returns:

The distance.

setDistance

public NearestNeighbors.Neighbor.Builder setDistance(double value)

 The distance between the neighbor and the query vector.
 

double distance = 2;

Parameters:

value - The distance to set.

Returns:

This builder for chaining.

clearDistance

public NearestNeighbors.Neighbor.Builder clearDistance()

 The distance between the neighbor and the query vector.
 

double distance = 2;

Returns:

This builder for chaining.

hasEntityKeyValues

public boolean hasEntityKeyValues()

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Specified by:

hasEntityKeyValues in interface NearestNeighbors.NeighborOrBuilder

Returns:

Whether the entityKeyValues field is set.

getEntityKeyValues

public FetchFeatureValuesResponse getEntityKeyValues()

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Specified by:

getEntityKeyValues in interface NearestNeighbors.NeighborOrBuilder

Returns:

The entityKeyValues.

setEntityKeyValues

public NearestNeighbors.Neighbor.Builder setEntityKeyValues(FetchFeatureValuesResponse value)

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

setEntityKeyValues

public NearestNeighbors.Neighbor.Builder setEntityKeyValues(FetchFeatureValuesResponse.Builder builderForValue)

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

mergeEntityKeyValues

public NearestNeighbors.Neighbor.Builder mergeEntityKeyValues(FetchFeatureValuesResponse value)

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

clearEntityKeyValues

public NearestNeighbors.Neighbor.Builder clearEntityKeyValues()

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

getEntityKeyValuesBuilder

public FetchFeatureValuesResponse.Builder getEntityKeyValuesBuilder()

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

getEntityKeyValuesOrBuilder

public FetchFeatureValuesResponseOrBuilder getEntityKeyValuesOrBuilder()

 The attributes of the neighbor, e.g. filters, crowding and metadata
 Note that full entities are returned only when "return_full_entity"
 is set to true. Otherwise, only the "entity_id" and "distance" fields
 are populated.
 

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Specified by:

getEntityKeyValuesOrBuilder in interface NearestNeighbors.NeighborOrBuilder