com.google.cloud.aiplatform.v1

Class ReadIndexDatapointsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>

com.google.cloud.aiplatform.v1.ReadIndexDatapointsRequest.Builder

All Implemented Interfaces:

ReadIndexDatapointsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ReadIndexDatapointsRequest

public static final class ReadIndexDatapointsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>
implements ReadIndexDatapointsRequestOrBuilder

 The request message for
 [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints].
 

Protobuf type google.cloud.aiplatform.v1.ReadIndexDatapointsRequest

Method Summary

Modifier and Type	Method and Description
ReadIndexDatapointsRequest.Builder	addAllIds(Iterable<String> values) IDs of the datapoints to be searched for.
ReadIndexDatapointsRequest.Builder	addIds(String value) IDs of the datapoints to be searched for.
ReadIndexDatapointsRequest.Builder	addIdsBytes(com.google.protobuf.ByteString value) IDs of the datapoints to be searched for.
ReadIndexDatapointsRequest	build()
ReadIndexDatapointsRequest	buildPartial()
ReadIndexDatapointsRequest.Builder	clear()
ReadIndexDatapointsRequest.Builder	clearDeployedIndexId() The ID of the DeployedIndex that will serve the request.
ReadIndexDatapointsRequest.Builder	clearIds() IDs of the datapoints to be searched for.
ReadIndexDatapointsRequest.Builder	clearIndexEndpoint() Required.
ReadIndexDatapointsRequest	getDefaultInstanceForType()
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.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
com.google.protobuf.ProtocolStringList	getIdsList() IDs of the datapoints to be searched for.
String	getIndexEndpoint() Required.
com.google.protobuf.ByteString	getIndexEndpointBytes() Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ReadIndexDatapointsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ReadIndexDatapointsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ReadIndexDatapointsRequest.Builder	mergeFrom(ReadIndexDatapointsRequest other)
ReadIndexDatapointsRequest.Builder	setDeployedIndexId(String value) The ID of the DeployedIndex that will serve the request.
ReadIndexDatapointsRequest.Builder	setDeployedIndexIdBytes(com.google.protobuf.ByteString value) The ID of the DeployedIndex that will serve the request.
ReadIndexDatapointsRequest.Builder	setIds(int index, String value) IDs of the datapoints to be searched for.
ReadIndexDatapointsRequest.Builder	setIndexEndpoint(String value) Required.
ReadIndexDatapointsRequest.Builder	setIndexEndpointBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>

clear

public ReadIndexDatapointsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>

getDefaultInstanceForType

public ReadIndexDatapointsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ReadIndexDatapointsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ReadIndexDatapointsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ReadIndexDatapointsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadIndexDatapointsRequest.Builder>

mergeFrom

public ReadIndexDatapointsRequest.Builder mergeFrom(ReadIndexDatapointsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ReadIndexDatapointsRequest.Builder>

mergeFrom

public ReadIndexDatapointsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadIndexDatapointsRequest.Builder>

Throws:

IOException

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

Specified by:

getIndexEndpoint in interface ReadIndexDatapointsRequestOrBuilder

Returns:

The indexEndpoint.

getIndexEndpointBytes

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

Specified by:

getIndexEndpointBytes in interface ReadIndexDatapointsRequestOrBuilder

Returns:

The bytes for indexEndpoint.

setIndexEndpoint

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

Parameters:

value - The indexEndpoint to set.

Returns:

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:

This builder for chaining.

setIndexEndpointBytes

public ReadIndexDatapointsRequest.Builder setIndexEndpointBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for indexEndpoint to set.

Returns:

This builder for chaining.

getDeployedIndexId

public String getDeployedIndexId()

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Specified by:

getDeployedIndexId in interface ReadIndexDatapointsRequestOrBuilder

Returns:

The deployedIndexId.

getDeployedIndexIdBytes

public com.google.protobuf.ByteString getDeployedIndexIdBytes()

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Specified by:

getDeployedIndexIdBytes in interface ReadIndexDatapointsRequestOrBuilder

Returns:

The bytes for deployedIndexId.

setDeployedIndexId

public ReadIndexDatapointsRequest.Builder setDeployedIndexId(String value)

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Parameters:

value - The deployedIndexId to set.

Returns:

This builder for chaining.

clearDeployedIndexId

public ReadIndexDatapointsRequest.Builder clearDeployedIndexId()

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Returns:

This builder for chaining.

setDeployedIndexIdBytes

public ReadIndexDatapointsRequest.Builder setDeployedIndexIdBytes(com.google.protobuf.ByteString value)

 The ID of the DeployedIndex that will serve the request.
 

string deployed_index_id = 2;

Parameters:

value - The bytes for deployedIndexId to set.

Returns:

This builder for chaining.

getIdsList

public com.google.protobuf.ProtocolStringList getIdsList()

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Specified by:

getIdsList in interface ReadIndexDatapointsRequestOrBuilder

Returns:

A list containing the ids.

getIdsCount

public int getIdsCount()

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Specified by:

getIdsCount in interface ReadIndexDatapointsRequestOrBuilder

Returns:

The count of ids.

getIds

public String getIds(int index)

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Specified by:

getIds in interface ReadIndexDatapointsRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The ids at the given index.

getIdsBytes

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

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Specified by:

getIdsBytes in interface ReadIndexDatapointsRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ids at the given index.

setIds

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

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

index - The index to set the value at.

value - The ids to set.

Returns:

This builder for chaining.

addIds

public ReadIndexDatapointsRequest.Builder addIds(String value)

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

value - The ids to add.

Returns:

This builder for chaining.

addAllIds

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

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

values - The ids to add.

Returns:

This builder for chaining.

clearIds

public ReadIndexDatapointsRequest.Builder clearIds()

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Returns:

This builder for chaining.

addIdsBytes

public ReadIndexDatapointsRequest.Builder addIdsBytes(com.google.protobuf.ByteString value)

 IDs of the datapoints to be searched for.
 

repeated string ids = 3;

Parameters:

value - The bytes of the ids to add.

Returns:

This builder for chaining.