Package com.google.cloud.aiplatform.v1beta1

Class ReadIndexDatapointsRequest

  • All Implemented Interfaces:
    ReadIndexDatapointsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReadIndexDatapointsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReadIndexDatapointsRequestOrBuilder
     The request message for
 [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints].
    Protobuf type google.cloud.aiplatform.v1beta1.ReadIndexDatapointsRequest
    See Also:
    Serialized Form

    • Field Detail

      • INDEX_ENDPOINT_FIELD_NUMBER

        public static final int INDEX_ENDPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYED_INDEX_ID_FIELD_NUMBER

        public static final int DEPLOYED_INDEX_ID_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

      • 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 ReadIndexDatapointsRequestOrBuilder
        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 ReadIndexDatapointsRequestOrBuilder
        Returns:
        The bytes for indexEndpoint.

      • getDeployedIndexIdBytes

        public com.google.protobuf.ByteString getDeployedIndexIdBytes()
         The ID of the DeployedIndex that will serve the request.
        string deployed_index_id = 2;
        Specified by:
        getDeployedIndexIdBytes in interface ReadIndexDatapointsRequestOrBuilder
        Returns:
        The bytes for deployedIndexId.

      • getIdsList

        public com.google.protobuf.ProtocolStringList getIdsList()
         IDs of the datapoints to be searched for.
        repeated string ids = 3;
        Specified by:
        getIdsList in interface ReadIndexDatapointsRequestOrBuilder
        Returns:
        A list containing the ids.

      • getIds

        public String getIds​(int index)
         IDs of the datapoints to be searched for.
        repeated string ids = 3;
        Specified by:
        getIds in interface ReadIndexDatapointsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The ids at the given index.

      • getIdsBytes

        public com.google.protobuf.ByteString getIdsBytes​(int index)
         IDs of the datapoints to be searched for.
        repeated string ids = 3;
        Specified by:
        getIdsBytes in interface ReadIndexDatapointsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the ids at the given index.

      • 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 ReadIndexDatapointsRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ReadIndexDatapointsRequest> 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 ReadIndexDatapointsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder