Package com.google.cloud.aiplatform.v1

Class FindNeighborsRequest.Builder

  • All Implemented Interfaces:
    FindNeighborsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    FindNeighborsRequest
    public static final class FindNeighborsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FindNeighborsRequest.Builder>
implements FindNeighborsRequestOrBuilder
     The request message for
 [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
    Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

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

      • getIndexEndpoint

        public String getIndexEndpoint()
         Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
        string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getIndexEndpoint in interface FindNeighborsRequestOrBuilder
        Returns:
        The indexEndpoint.

      • getIndexEndpointBytes

        public com.google.protobuf.ByteString getIndexEndpointBytes()
         Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
        string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getIndexEndpointBytes in interface FindNeighborsRequestOrBuilder
        Returns:
        The bytes for indexEndpoint.

      • setIndexEndpoint

        public FindNeighborsRequest.Builder setIndexEndpoint​(String value)
         Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
        string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The indexEndpoint to set.
        Returns:
        This builder for chaining.

      • clearIndexEndpoint

        public FindNeighborsRequest.Builder clearIndexEndpoint()
         Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
        string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setIndexEndpointBytes

        public FindNeighborsRequest.Builder setIndexEndpointBytes​(com.google.protobuf.ByteString value)
         Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
        string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for indexEndpoint to set.
        Returns:
        This builder for chaining.

      • getDeployedIndexId

        public String getDeployedIndexId()
         The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
        string deployed_index_id = 2;
        Specified by:
        getDeployedIndexId in interface FindNeighborsRequestOrBuilder
        Returns:
        The deployedIndexId.

      • getDeployedIndexIdBytes

        public com.google.protobuf.ByteString getDeployedIndexIdBytes()
         The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
        string deployed_index_id = 2;
        Specified by:
        getDeployedIndexIdBytes in interface FindNeighborsRequestOrBuilder
        Returns:
        The bytes for deployedIndexId.

      • setDeployedIndexId

        public FindNeighborsRequest.Builder setDeployedIndexId​(String value)
         The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
        string deployed_index_id = 2;
        Parameters:
        value - The deployedIndexId to set.
        Returns:
        This builder for chaining.

      • clearDeployedIndexId

        public FindNeighborsRequest.Builder clearDeployedIndexId()
         The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
        string deployed_index_id = 2;
        Returns:
        This builder for chaining.

      • setDeployedIndexIdBytes

        public FindNeighborsRequest.Builder setDeployedIndexIdBytes​(com.google.protobuf.ByteString value)
         The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
        string deployed_index_id = 2;
        Parameters:
        value - The bytes for deployedIndexId to set.
        Returns:
        This builder for chaining.

      • getQueriesCount

        public int getQueriesCount()
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
        Specified by:
        getQueriesCount in interface FindNeighborsRequestOrBuilder

      • clearQueries

        public FindNeighborsRequest.Builder clearQueries()
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • removeQueries

        public FindNeighborsRequest.Builder removeQueries​(int index)
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • getQueriesBuilder

        public FindNeighborsRequest.Query.Builder getQueriesBuilder​(int index)
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • addQueriesBuilder

        public FindNeighborsRequest.Query.Builder addQueriesBuilder()
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • addQueriesBuilder

        public FindNeighborsRequest.Query.Builder addQueriesBuilder​(int index)
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • getQueriesBuilderList

        public List<FindNeighborsRequest.Query.Builder> getQueriesBuilderList()
         The list of queries.
        repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

      • getReturnFullDatapoint

        public boolean getReturnFullDatapoint()
         If set to true, the full datapoints (including all vector values and
 restricts) of the nearest neighbors are returned.
 Note that returning full datapoint will significantly increase the
 latency and cost of the query.
        bool return_full_datapoint = 4;
        Specified by:
        getReturnFullDatapoint in interface FindNeighborsRequestOrBuilder
        Returns:
        The returnFullDatapoint.

      • setReturnFullDatapoint

        public FindNeighborsRequest.Builder setReturnFullDatapoint​(boolean value)
         If set to true, the full datapoints (including all vector values and
 restricts) of the nearest neighbors are returned.
 Note that returning full datapoint will significantly increase the
 latency and cost of the query.
        bool return_full_datapoint = 4;
        Parameters:
        value - The returnFullDatapoint to set.
        Returns:
        This builder for chaining.

      • clearReturnFullDatapoint

        public FindNeighborsRequest.Builder clearReturnFullDatapoint()
         If set to true, the full datapoints (including all vector values and
 restricts) of the nearest neighbors are returned.
 Note that returning full datapoint will significantly increase the
 latency and cost of the query.
        bool return_full_datapoint = 4;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final FindNeighborsRequest.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<FindNeighborsRequest.Builder>

      • mergeUnknownFields

        public final FindNeighborsRequest.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<FindNeighborsRequest.Builder>