Class ReadIndexDatapointsRequest.Builder (3.42.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.v1.ReadIndexDatapointsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadIndexDatapointsRequest.Builder

Implements

ReadIndexDatapointsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<String>` The ids to add.

Returns
Type	Description
`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
Name	Description
`value`	`String` The ids to add.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes of the ids to add.

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadIndexDatapointsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ReadIndexDatapointsRequest build()

Returns
Type	Description
`ReadIndexDatapointsRequest`

buildPartial()

public ReadIndexDatapointsRequest buildPartial()

Returns
Type	Description
`ReadIndexDatapointsRequest`

clear()

public ReadIndexDatapointsRequest.Builder clear()

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDeployedIndexId()

public ReadIndexDatapointsRequest.Builder clearDeployedIndexId()

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReadIndexDatapointsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIds()

public ReadIndexDatapointsRequest.Builder clearIds()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
Type	Description
`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
Type	Description
`ReadIndexDatapointsRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadIndexDatapointsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ReadIndexDatapointsRequest.Builder clone()

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ReadIndexDatapointsRequest getDefaultInstanceForType()

Returns
Type	Description
`ReadIndexDatapointsRequest`

getDeployedIndexId()

public String getDeployedIndexId()

The ID of the DeployedIndex that will serve the request.

string deployed_index_id = 2;

Returns
Type	Description
`String`	The deployedIndexId.

getDeployedIndexIdBytes()

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIds(int index)

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.

getIdsBytes(int 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.

getIdsCount()

public int getIdsCount()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
Type	Description
`int`	The count of ids.

getIdsList()

public ProtocolStringList getIdsList()

IDs of the datapoints to be searched for.

repeated string ids = 3;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`ByteString`	The bytes for indexEndpoint.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ReadIndexDatapointsRequest other)

public ReadIndexDatapointsRequest.Builder mergeFrom(ReadIndexDatapointsRequest other)

Parameter
Name	Description
`other`	`ReadIndexDatapointsRequest`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadIndexDatapointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ReadIndexDatapointsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadIndexDatapointsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`value`	`String` The deployedIndexId to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for deployedIndexId to set.

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadIndexDatapointsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The ids to set.

Returns
Type	Description
`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
Name	Description
`value`	`String` The indexEndpoint to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for indexEndpoint to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadIndexDatapointsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadIndexDatapointsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)