com.google.cloud.aiplatform.v1

Interface ReadIndexDatapointsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ReadIndexDatapointsRequest, ReadIndexDatapointsRequest.Builder

public interface ReadIndexDatapointsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDeployedIndexId() The ID of the DeployedIndex that will serve the request.
com.google.protobuf.ByteString	getDeployedIndexIdBytes() The ID of the DeployedIndex that will serve the request.
String	getIds(int index) IDs of the datapoints to be searched for.
com.google.protobuf.ByteString	getIdsBytes(int index) IDs of the datapoints to be searched for.
int	getIdsCount() IDs of the datapoints to be searched for.
List<String>	getIdsList() IDs of the datapoints to be searched for.
String	getIndexEndpoint() Required.
com.google.protobuf.ByteString	getIndexEndpointBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIndexEndpoint

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:

The indexEndpoint.

getIndexEndpointBytes

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) = { ... }

Returns:

The bytes for indexEndpoint.

getDeployedIndexId

String getDeployedIndexId()

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Returns:

The deployedIndexId.

getDeployedIndexIdBytes

com.google.protobuf.ByteString getDeployedIndexIdBytes()

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Returns:

The bytes for deployedIndexId.

getIdsList

List<String> getIdsList()

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Returns:

A list containing the ids.

getIdsCount

int getIdsCount()

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Returns:

The count of ids.

getIds

String getIds(int index)

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

index - The index of the element to return.

Returns:

The ids at the given index.

getIdsBytes

com.google.protobuf.ByteString getIdsBytes(int index)

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ids at the given index.