Package com.google.cloud.aiplatform.v1beta1

Class IndexDatapoint.Builder

  • All Implemented Interfaces:
    IndexDatapointOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    IndexDatapoint
    public static final class IndexDatapoint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>
implements IndexDatapointOrBuilder
     A datapoint of Index.
    Protobuf type google.cloud.aiplatform.v1beta1.IndexDatapoint

    • Method Detail

      • 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.Builder<IndexDatapoint.Builder>

      • clear

        public IndexDatapoint.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.GeneratedMessageV3.Builder<IndexDatapoint.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.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public IndexDatapoint.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • clearField

        public IndexDatapoint.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • clearOneof

        public IndexDatapoint.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • setRepeatedField

        public IndexDatapoint.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • addRepeatedField

        public IndexDatapoint.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • mergeFrom

        public IndexDatapoint.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<IndexDatapoint.Builder>

      • isInitialized

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

      • mergeFrom

        public IndexDatapoint.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<IndexDatapoint.Builder>
        Throws:
        IOException

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

      • setDatapointId

        public IndexDatapoint.Builder setDatapointId​(String value)
         Required. Unique identifier of the datapoint.
        string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The datapointId to set.
        Returns:
        This builder for chaining.

      • clearDatapointId

        public IndexDatapoint.Builder clearDatapointId()
         Required. Unique identifier of the datapoint.
        string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setDatapointIdBytes

        public IndexDatapoint.Builder setDatapointIdBytes​(com.google.protobuf.ByteString value)
         Required. Unique identifier of the datapoint.
        string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for datapointId to set.
        Returns:
        This builder for chaining.

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

      • setFeatureVector

        public IndexDatapoint.Builder setFeatureVector​(int index,
                                               float value)
         Required. Feature embedding vector. An array of numbers with the length of
 [NearestNeighborSearchConfig.dimensions].
        repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The featureVector to set.
        Returns:
        This builder for chaining.

      • addFeatureVector

        public IndexDatapoint.Builder addFeatureVector​(float value)
         Required. Feature embedding vector. An array of numbers with the length of
 [NearestNeighborSearchConfig.dimensions].
        repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The featureVector to add.
        Returns:
        This builder for chaining.

      • addAllFeatureVector

        public IndexDatapoint.Builder addAllFeatureVector​(Iterable<? extends Float> values)
         Required. Feature embedding vector. An array of numbers with the length of
 [NearestNeighborSearchConfig.dimensions].
        repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The featureVector to add.
        Returns:
        This builder for chaining.

      • clearFeatureVector

        public IndexDatapoint.Builder clearFeatureVector()
         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:
        This builder for chaining.

      • 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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRestrictsList 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.v1beta1.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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRestricts in interface IndexDatapointOrBuilder

      • setRestricts

        public IndexDatapoint.Builder setRestricts​(int index,
                                           IndexDatapoint.Restriction value)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • setRestricts

        public IndexDatapoint.Builder setRestricts​(int index,
                                           IndexDatapoint.Restriction.Builder builderForValue)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addRestricts

        public IndexDatapoint.Builder addRestricts​(IndexDatapoint.Restriction value)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addRestricts

        public IndexDatapoint.Builder addRestricts​(int index,
                                           IndexDatapoint.Restriction value)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addRestricts

        public IndexDatapoint.Builder addRestricts​(IndexDatapoint.Restriction.Builder builderForValue)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addRestricts

        public IndexDatapoint.Builder addRestricts​(int index,
                                           IndexDatapoint.Restriction.Builder builderForValue)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addAllRestricts

        public IndexDatapoint.Builder addAllRestricts​(Iterable<? extends IndexDatapoint.Restriction> values)
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • clearRestricts

        public IndexDatapoint.Builder clearRestricts()
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • removeRestricts

        public IndexDatapoint.Builder removeRestricts​(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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getRestrictsBuilder

        public IndexDatapoint.Restriction.Builder getRestrictsBuilder​(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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • 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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRestrictsOrBuilder 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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRestrictsOrBuilderList in interface IndexDatapointOrBuilder

      • addRestrictsBuilder

        public IndexDatapoint.Restriction.Builder addRestrictsBuilder()
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • addRestrictsBuilder

        public IndexDatapoint.Restriction.Builder addRestrictsBuilder​(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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getRestrictsBuilderList

        public List<IndexDatapoint.Restriction.Builder> getRestrictsBuilderList()
         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.v1beta1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

      • 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.v1beta1.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.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCrowdingTag in interface IndexDatapointOrBuilder
        Returns:
        The crowdingTag.

      • setCrowdingTag

        public IndexDatapoint.Builder setCrowdingTag​(IndexDatapoint.CrowdingTag value)
         Optional. CrowdingTag of the datapoint, the number of neighbors to return
 in each crowding can be configured during query.
        .google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

      • setCrowdingTag

        public IndexDatapoint.Builder setCrowdingTag​(IndexDatapoint.CrowdingTag.Builder builderForValue)
         Optional. CrowdingTag of the datapoint, the number of neighbors to return
 in each crowding can be configured during query.
        .google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

      • mergeCrowdingTag

        public IndexDatapoint.Builder mergeCrowdingTag​(IndexDatapoint.CrowdingTag value)
         Optional. CrowdingTag of the datapoint, the number of neighbors to return
 in each crowding can be configured during query.
        .google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

      • clearCrowdingTag

        public IndexDatapoint.Builder clearCrowdingTag()
         Optional. CrowdingTag of the datapoint, the number of neighbors to return
 in each crowding can be configured during query.
        .google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getCrowdingTagBuilder

        public IndexDatapoint.CrowdingTag.Builder getCrowdingTagBuilder()
         Optional. CrowdingTag of the datapoint, the number of neighbors to return
 in each crowding can be configured during query.
        .google.cloud.aiplatform.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

      • 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.v1beta1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCrowdingTagOrBuilder in interface IndexDatapointOrBuilder

      • setUnknownFields

        public final IndexDatapoint.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>

      • mergeUnknownFields

        public final IndexDatapoint.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.Builder>