Package com.google.cloud.aiplatform.v1

Class IndexDatapoint

  • All Implemented Interfaces:
    IndexDatapointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class IndexDatapoint
extends com.google.protobuf.GeneratedMessageV3
implements IndexDatapointOrBuilder
     A datapoint of Index.
    Protobuf type google.cloud.aiplatform.v1.IndexDatapoint
    See Also:
    Serialized Form

    • Field Detail

      • DATAPOINT_ID_FIELD_NUMBER

        public static final int DATAPOINT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_VECTOR_FIELD_NUMBER

        public static final int FEATURE_VECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CROWDING_TAG_FIELD_NUMBER

        public static final int CROWDING_TAG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getDatapointId

        public String getDatapointId()
         Required. Unique identifier of the datapoint.
        string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatapointId in interface IndexDatapointOrBuilder
        Returns:
        The datapointId.

      • getDatapointIdBytes

        public com.google.protobuf.ByteString getDatapointIdBytes()
         Required. Unique identifier of the datapoint.
        string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatapointIdBytes in interface IndexDatapointOrBuilder
        Returns:
        The bytes for datapointId.

      • 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];
        Specified by:
        getFeatureVectorList in interface IndexDatapointOrBuilder
        Returns:
        A list containing the featureVector.

      • 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];
        Specified by:
        getFeatureVectorCount in interface IndexDatapointOrBuilder
        Returns:
        The count of featureVector.

      • getFeatureVector

        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];
        Specified by:
        getFeatureVector in interface IndexDatapointOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The featureVector at the given index.

      • 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];
        Specified by:
        getRestrictsList in interface IndexDatapointOrBuilder

      • 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];
        Specified by:
        getRestrictsOrBuilderList in interface IndexDatapointOrBuilder

      • 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];
        Specified by:
        getRestrictsCount in interface IndexDatapointOrBuilder

      • getRestricts

        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];
        Specified by:
        getRestricts in interface IndexDatapointOrBuilder

      • getRestrictsOrBuilder

        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];
        Specified by:
        getRestrictsOrBuilder in interface IndexDatapointOrBuilder

      • 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];
        Specified by:
        hasCrowdingTag in interface IndexDatapointOrBuilder
        Returns:
        Whether the crowdingTag field is set.

      • 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];
        Specified by:
        getCrowdingTag in interface IndexDatapointOrBuilder
        Returns:
        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];
        Specified by:
        getCrowdingTagOrBuilder in interface IndexDatapointOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static IndexDatapoint parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IndexDatapoint parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public IndexDatapoint.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public IndexDatapoint.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected IndexDatapoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static IndexDatapoint getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<IndexDatapoint> parser()

      • getParserForType

        public com.google.protobuf.Parser<IndexDatapoint> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public IndexDatapoint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder