Class ReadIndexDatapointsRequest (3.24.0)

public final class ReadIndexDatapointsRequest extends GeneratedMessageV3 implements ReadIndexDatapointsRequestOrBuilder

The request message for MatchService.ReadIndexDatapoints.

Protobuf type google.cloud.aiplatform.v1.ReadIndexDatapointsRequest

Static Fields

DEPLOYED_INDEX_ID_FIELD_NUMBER

public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
TypeDescription
int

IDS_FIELD_NUMBER

public static final int IDS_FIELD_NUMBER
Field Value
TypeDescription
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadIndexDatapointsRequest getDefaultInstance()
Returns
TypeDescription
ReadIndexDatapointsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadIndexDatapointsRequest.Builder newBuilder()
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

newBuilder(ReadIndexDatapointsRequest prototype)

public static ReadIndexDatapointsRequest.Builder newBuilder(ReadIndexDatapointsRequest prototype)
Parameter
NameDescription
prototypeReadIndexDatapointsRequest
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReadIndexDatapointsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadIndexDatapointsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadIndexDatapointsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadIndexDatapointsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadIndexDatapointsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadIndexDatapointsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadIndexDatapointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadIndexDatapointsRequest> parser()
Returns
TypeDescription
Parser<ReadIndexDatapointsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ReadIndexDatapointsRequest getDefaultInstanceForType()
Returns
TypeDescription
ReadIndexDatapointsRequest

getDeployedIndexId()

public String getDeployedIndexId()

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Returns
TypeDescription
String

The deployedIndexId.

getDeployedIndexIdBytes()

public ByteString getDeployedIndexIdBytes()

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Returns
TypeDescription
ByteString

The bytes for deployedIndexId.

getIds(int index)

public String getIds(int index)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The ids at the given index.

getIdsBytes(int index)

public ByteString getIdsBytes(int index)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the ids at the given index.

getIdsCount()

public int getIdsCount()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
TypeDescription
int

The count of ids.

getIdsList()

public ProtocolStringList getIdsList()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the ids.

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

Returns
TypeDescription
String

The indexEndpoint.

getIndexEndpointBytes()

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
TypeDescription
ByteString

The bytes for indexEndpoint.

getParserForType()

public Parser<ReadIndexDatapointsRequest> getParserForType()
Returns
TypeDescription
Parser<ReadIndexDatapointsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadIndexDatapointsRequest.Builder newBuilderForType()
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadIndexDatapointsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadIndexDatapointsRequest.Builder toBuilder()
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException