Class IndexDatapoint (3.16.0)

public final class IndexDatapoint extends GeneratedMessageV3 implements IndexDatapointOrBuilder

A datapoint of Index.

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint

Static Fields

CROWDING_TAG_FIELD_NUMBER

public static final int CROWDING_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

DATAPOINT_ID_FIELD_NUMBER

public static final int DATAPOINT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURE_VECTOR_FIELD_NUMBER

public static final int FEATURE_VECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

RESTRICTS_FIELD_NUMBER

public static final int RESTRICTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static IndexDatapoint getDefaultInstance()
Returns
TypeDescription
IndexDatapoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static IndexDatapoint.Builder newBuilder()
Returns
TypeDescription
IndexDatapoint.Builder

newBuilder(IndexDatapoint prototype)

public static IndexDatapoint.Builder newBuilder(IndexDatapoint prototype)
Parameter
NameDescription
prototypeIndexDatapoint
Returns
TypeDescription
IndexDatapoint.Builder

parseDelimitedFrom(InputStream input)

public static IndexDatapoint parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static IndexDatapoint parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexDatapoint parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexDatapoint parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static IndexDatapoint parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static IndexDatapoint parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<IndexDatapoint> parser()
Returns
TypeDescription
Parser<IndexDatapoint>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCrowdingTag()

public IndexDatapoint.CrowdingTag getCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.CrowdingTag

The crowdingTag.

getCrowdingTagOrBuilder()

public IndexDatapoint.CrowdingTagOrBuilder getCrowdingTagOrBuilder()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.CrowdingTagOrBuilder

getDatapointId()

public String getDatapointId()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The datapointId.

getDatapointIdBytes()

public ByteString getDatapointIdBytes()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for datapointId.

getDefaultInstanceForType()

public IndexDatapoint getDefaultInstanceForType()
Returns
TypeDescription
IndexDatapoint

getFeatureVector(int index)

public float getFeatureVector(int index)

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
float

The featureVector at the given index.

getFeatureVectorCount()

public int getFeatureVectorCount()

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of featureVector.

getFeatureVectorList()

public List<Float> getFeatureVectorList()

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Float>

A list containing the featureVector.

getParserForType()

public Parser<IndexDatapoint> getParserForType()
Returns
TypeDescription
Parser<IndexDatapoint>
Overrides

getRestricts(int index)

public IndexDatapoint.Restriction getRestricts(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.Restriction

getRestrictsCount()

public int getRestrictsCount()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getRestrictsList()

public List<IndexDatapoint.Restriction> getRestrictsList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<Restriction>

getRestrictsOrBuilder(int index)

public IndexDatapoint.RestrictionOrBuilder getRestrictsOrBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.RestrictionOrBuilder

getRestrictsOrBuilderList()

public List<? extends IndexDatapoint.RestrictionOrBuilder> getRestrictsOrBuilderList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.IndexDatapoint.RestrictionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCrowdingTag()

public boolean hasCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the crowdingTag field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public IndexDatapoint.Builder newBuilderForType()
Returns
TypeDescription
IndexDatapoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexDatapoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public IndexDatapoint.Builder toBuilder()
Returns
TypeDescription
IndexDatapoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException