Send feedback
  
   
 
  
    
      Class ReadIndexDatapointsRequest (3.79.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  ReadIndexDatapointsRequest   extends   GeneratedMessageV3   implements   ReadIndexDatapointsRequestOrBuilder  
   The request message for
 MatchService.ReadIndexDatapoints .
 Protobuf type google.cloud.aiplatform.v1.ReadIndexDatapointsRequest
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  
  
    
public   static   final   int   DEPLOYED_INDEX_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   IDS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   INDEX_ENDPOINT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  
    
public   static   ReadIndexDatapointsRequest   getDefaultInstance ()  
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  
    
public   static   ReadIndexDatapointsRequest . Builder   newBuilder ()  
  
  
    
public   static   ReadIndexDatapointsRequest . Builder   newBuilder ( ReadIndexDatapointsRequest   prototype )  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( ByteString   data )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( ByteBuffer   data )  
  
  
  
  
    
public   static   ReadIndexDatapointsRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Parser<ReadIndexDatapointsRequest>   parser ()  
  
  Methods
   
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  
    
public   ReadIndexDatapointsRequest   getDefaultInstanceForType ()  
  
  
    
public   String   getDeployedIndexId ()  
   The ID of the DeployedIndex that will serve the request.
 string deployed_index_id = 2;
    
      
        Returns  
      
        Type Description  
      
        String The deployedIndexId.
 
     
  
  
    
public   ByteString   getDeployedIndexIdBytes ()  
   The ID of the DeployedIndex that will serve the request.
 string deployed_index_id = 2;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for deployedIndexId.
 
     
  
  
    
public   String   getIds ( int   index )  
   IDs of the datapoints to be searched for.
 repeated string ids = 3;
    
      
        Parameter  
      
        Name Description  
      
        indexint The index of the element to return.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        String The ids at the given index.
 
     
  
  
    
public   ByteString   getIdsBytes ( int   index )  
   IDs of the datapoints to be searched for.
 repeated string ids = 3;
    
      
        Parameter  
      
        Name Description  
      
        indexint The index of the value to return.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes of the ids at the given index.
 
     
  
   IDs of the datapoints to be searched for.
 repeated string ids = 3;
    
      
        Returns  
      
        Type Description  
      
        int The count of ids.
 
     
  
  
    
public   ProtocolStringList   getIdsList ()  
   IDs of the datapoints to be searched for.
 repeated string ids = 3;
    
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) = { ... }
 
    
      
        Returns  
      
        Type Description  
      
        String The indexEndpoint.
 
     
  
  
    
public   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) = { ... }
 
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for indexEndpoint.
 
     
  
  
    
public   Parser<ReadIndexDatapointsRequest>   getParserForType ()  
  
  Overrides 
  
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  
    
public   ReadIndexDatapointsRequest . Builder   newBuilderForType ()  
  
  
    
protected   ReadIndexDatapointsRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  
    
public   ReadIndexDatapointsRequest . Builder   toBuilder ()  
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]