Send feedback
Class NearestNeighborQuery.StringFilter (3.40.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.40.0keyboard_arrow_down
public static final class NearestNeighborQuery . StringFilter extends GeneratedMessageV3 implements NearestNeighborQuery . StringFilterOrBuilder
String filter is used to search a subset of the entities by using boolean
rules on string columns.
For example: if a query specifies string filter
with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}','
then that query will match entities that are red or blue, but if those
points are also purple, then they will be excluded even if they are
red/blue. Only string filter is supported for now, numeric filter will be
supported in the near future.
Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ALLOW_TOKENS_FIELD_NUMBER
Field Value
Type Description
int
public static final int DENY_TOKENS_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static NearestNeighborQuery . StringFilter getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static NearestNeighborQuery . StringFilter . Builder newBuilder ()
public static NearestNeighborQuery . StringFilter . Builder newBuilder ( NearestNeighborQuery . StringFilter prototype )
public static NearestNeighborQuery . StringFilter parseDelimitedFrom ( InputStream input )
public static NearestNeighborQuery . StringFilter parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static NearestNeighborQuery . StringFilter parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static NearestNeighborQuery . StringFilter parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static NearestNeighborQuery . StringFilter parseFrom ( ByteString data )
public static NearestNeighborQuery . StringFilter parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static NearestNeighborQuery . StringFilter parseFrom ( CodedInputStream input )
public static NearestNeighborQuery . StringFilter parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static NearestNeighborQuery . StringFilter parseFrom ( InputStream input )
public static NearestNeighborQuery . StringFilter parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static NearestNeighborQuery . StringFilter parseFrom ( ByteBuffer data )
public static NearestNeighborQuery . StringFilter parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<NearestNeighborQuery . StringFilter > parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public String getAllowTokens ( int index )
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The allowTokens at the given index.
public ByteString getAllowTokensBytes ( int index )
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the allowTokens at the given index.
public int getAllowTokensCount ()
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The count of allowTokens.
public ProtocolStringList getAllowTokensList ()
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
public NearestNeighborQuery . StringFilter getDefaultInstanceForType ()
public String getDenyTokens ( int index )
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The denyTokens at the given index.
public ByteString getDenyTokensBytes ( int index )
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the denyTokens at the given index.
public int getDenyTokensCount ()
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The count of denyTokens.
public ProtocolStringList getDenyTokensList ()
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Required. Column names in BigQuery that used as filters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The name.
public ByteString getNameBytes ()
Required. Column names in BigQuery that used as filters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for name.
public Parser<NearestNeighborQuery . StringFilter > getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public NearestNeighborQuery . StringFilter . Builder newBuilderForType ()
protected NearestNeighborQuery . StringFilter . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public NearestNeighborQuery . StringFilter . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[],[]]
