Class ReadIndexDatapointsRequest (3.13.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 3.13.0keyboard_arrow_down
public final class ReadIndexDatapointsRequest extends GeneratedMessageV3 implements ReadIndexDatapointsRequestOrBuilder
The request message for
MatchService.ReadIndexDatapoints .
Protobuf type google.cloud.aiplatform.v1beta1.ReadIndexDatapointsRequest
Static Fields
public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
public static final int IDS_FIELD_NUMBER
Field Value
public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Static Methods
public static ReadIndexDatapointsRequest getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static ReadIndexDatapointsRequest . Builder newBuilder ()
Returns
public static ReadIndexDatapointsRequest . Builder newBuilder ( ReadIndexDatapointsRequest prototype )
Parameter
Returns
public static ReadIndexDatapointsRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadIndexDatapointsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static ReadIndexDatapointsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<ReadIndexDatapointsRequest> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public ReadIndexDatapointsRequest getDefaultInstanceForType ()
Returns
public String getDeployedIndexId ()
The ID of the DeploydIndex that will serve the request.
string deployed_index_id = 2;
Returns
Type
Description
String
The deployedIndexId.
public ByteString getDeployedIndexIdBytes ()
The ID of the DeploydIndex 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
index
int
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
index
int
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;
Returns
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 ()
Returns
Overrides
public int getSerializedSize ()
Returns
Overrides
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public ReadIndexDatapointsRequest . Builder newBuilderForType ()
Returns
protected ReadIndexDatapointsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public ReadIndexDatapointsRequest . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]