Package com.google.cloud.aiplatform.v1

Class NearestNeighborQuery.Parameters

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters

All Implemented Interfaces:

NearestNeighborQuery.ParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

NearestNeighborQuery

public static final class NearestNeighborQuery.Parameters
extends com.google.protobuf.GeneratedMessage
implements NearestNeighborQuery.ParametersOrBuilder

 Parameters that can be overrided in each query to tune query latency and
 recall.
 

Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NearestNeighborQuery.Parameters.Builder	Parameters that can be overrided in each query to tune query latency and recall.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER
static final int	LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getApproximateNeighborCandidates()	Optional.
static NearestNeighborQuery.Parameters	getDefaultInstance()
NearestNeighborQuery.Parameters	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getLeafNodesSearchFraction()	Optional.
com.google.protobuf.Parser<NearestNeighborQuery.Parameters>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static NearestNeighborQuery.Parameters.Builder	newBuilder()
static NearestNeighborQuery.Parameters.Builder	newBuilder(NearestNeighborQuery.Parameters prototype)
NearestNeighborQuery.Parameters.Builder	newBuilderForType()
protected NearestNeighborQuery.Parameters.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static NearestNeighborQuery.Parameters	parseDelimitedFrom(InputStream input)
static NearestNeighborQuery.Parameters	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.Parameters	parseFrom(byte[] data)
static NearestNeighborQuery.Parameters	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.Parameters	parseFrom(com.google.protobuf.ByteString data)
static NearestNeighborQuery.Parameters	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.Parameters	parseFrom(com.google.protobuf.CodedInputStream input)
static NearestNeighborQuery.Parameters	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.Parameters	parseFrom(InputStream input)
static NearestNeighborQuery.Parameters	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.Parameters	parseFrom(ByteBuffer data)
static NearestNeighborQuery.Parameters	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<NearestNeighborQuery.Parameters>	parser()
NearestNeighborQuery.Parameters.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER

public static final int APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER

See Also:

• Constant Field Values

LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER

public static final int LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

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

getApproximateNeighborCandidates

public int getApproximateNeighborCandidates()

 Optional. The number of neighbors to find via approximate search before
 exact reordering is performed; if set, this value must be >
 neighbor_count.
 

int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getApproximateNeighborCandidates in interface NearestNeighborQuery.ParametersOrBuilder

Returns:

The approximateNeighborCandidates.

getLeafNodesSearchFraction

public double getLeafNodesSearchFraction()

 Optional. The fraction of the number of leaves to search, set at query
 time allows user to tune search performance. This value increase result
 in both search accuracy and latency increase. The value should be between
 0.0 and 1.0.
 

double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLeafNodesSearchFraction in interface NearestNeighborQuery.ParametersOrBuilder

Returns:

The leafNodesSearchFraction.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input)
                                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                          throws IOException

Throws:

IOException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(com.google.protobuf.CodedInputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static NearestNeighborQuery.Parameters parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

newBuilderForType

public NearestNeighborQuery.Parameters.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static NearestNeighborQuery.Parameters.Builder newBuilder()

newBuilder

public static NearestNeighborQuery.Parameters.Builder newBuilder(NearestNeighborQuery.Parameters prototype)

toBuilder

public NearestNeighborQuery.Parameters.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected NearestNeighborQuery.Parameters.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static NearestNeighborQuery.Parameters getDefaultInstance()

parser

public static com.google.protobuf.Parser<NearestNeighborQuery.Parameters> parser()

getParserForType

public com.google.protobuf.Parser<NearestNeighborQuery.Parameters> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public NearestNeighborQuery.Parameters getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder