Class ReadIndexDatapointsRequest.Builder (3.24.0)

public static final class ReadIndexDatapointsRequest.Builder extends GeneratedMessageV3.Builder<ReadIndexDatapointsRequest.Builder> implements ReadIndexDatapointsRequestOrBuilder

The request message for MatchService.ReadIndexDatapoints.

Protobuf type google.cloud.aiplatform.v1beta1.ReadIndexDatapointsRequest

Static Methods

getDescriptor()

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

Methods

addAllIds(Iterable<String> values)

public ReadIndexDatapointsRequest.Builder addAllIds(Iterable<String> values)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameter
NameDescription
valuesIterable<String>

The ids to add.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

addIds(String value)

public ReadIndexDatapointsRequest.Builder addIds(String value)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameter
NameDescription
valueString

The ids to add.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

addIdsBytes(ByteString value)

public ReadIndexDatapointsRequest.Builder addIdsBytes(ByteString value)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameter
NameDescription
valueByteString

The bytes of the ids to add.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadIndexDatapointsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

build()

public ReadIndexDatapointsRequest build()
Returns
TypeDescription
ReadIndexDatapointsRequest

buildPartial()

public ReadIndexDatapointsRequest buildPartial()
Returns
TypeDescription
ReadIndexDatapointsRequest

clear()

public ReadIndexDatapointsRequest.Builder clear()
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

clearDeployedIndexId()

public ReadIndexDatapointsRequest.Builder clearDeployedIndexId()

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReadIndexDatapointsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

clearIds()

public ReadIndexDatapointsRequest.Builder clearIds()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

clearIndexEndpoint()

public ReadIndexDatapointsRequest.Builder clearIndexEndpoint()

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
ReadIndexDatapointsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadIndexDatapointsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

clone()

public ReadIndexDatapointsRequest.Builder clone()
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ReadIndexDatapointsRequest other)

public ReadIndexDatapointsRequest.Builder mergeFrom(ReadIndexDatapointsRequest other)
Parameter
NameDescription
otherReadIndexDatapointsRequest
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadIndexDatapointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadIndexDatapointsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadIndexDatapointsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

setDeployedIndexId(String value)

public ReadIndexDatapointsRequest.Builder setDeployedIndexId(String value)

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Parameter
NameDescription
valueString

The deployedIndexId to set.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

setDeployedIndexIdBytes(ByteString value)

public ReadIndexDatapointsRequest.Builder setDeployedIndexIdBytes(ByteString value)

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Parameter
NameDescription
valueByteString

The bytes for deployedIndexId to set.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadIndexDatapointsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

setIds(int index, String value)

public ReadIndexDatapointsRequest.Builder setIds(int index, String value)

IDs of the datapoints to be searched for.

repeated string ids = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The ids to set.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

setIndexEndpoint(String value)

public ReadIndexDatapointsRequest.Builder setIndexEndpoint(String value)

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

Parameter
NameDescription
valueString

The indexEndpoint to set.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

setIndexEndpointBytes(ByteString value)

public ReadIndexDatapointsRequest.Builder setIndexEndpointBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for indexEndpoint to set.

Returns
TypeDescription
ReadIndexDatapointsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReadIndexDatapointsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadIndexDatapointsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadIndexDatapointsRequest.Builder
Overrides