Class NearestNeighborQuery.StringFilter.Builder (3.89.0)

3.89.0 (latest) 3.88.0 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

public static final class NearestNeighborQuery.StringFilter.Builder extends GeneratedMessage.Builder<NearestNeighborQuery.StringFilter.Builder> 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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > NearestNeighborQuery.StringFilter.Builder

Implements

NearestNeighborQuery.StringFilterOrBuilder

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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

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

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

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

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

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

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

addAllAllowTokens(Iterable<String> values)

public NearestNeighborQuery.StringFilter.Builder addAllAllowTokens(Iterable<String> values)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<String> The allowTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

addAllDenyTokens(Iterable<String> values)

public NearestNeighborQuery.StringFilter.Builder addAllDenyTokens(Iterable<String> values)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<String> The denyTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

addAllowTokens(String value)

public NearestNeighborQuery.StringFilter.Builder addAllowTokens(String value)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The allowTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

addAllowTokensBytes(ByteString value)

public NearestNeighborQuery.StringFilter.Builder addAllowTokensBytes(ByteString value)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes of the allowTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

addDenyTokens(String value)

public NearestNeighborQuery.StringFilter.Builder addDenyTokens(String value)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The denyTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

addDenyTokensBytes(ByteString value)

public NearestNeighborQuery.StringFilter.Builder addDenyTokensBytes(ByteString value)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes of the denyTokens to add.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

build()

public NearestNeighborQuery.StringFilter build()

Returns
Type	Description
NearestNeighborQuery.StringFilter

buildPartial()

public NearestNeighborQuery.StringFilter buildPartial()

Returns
Type	Description
NearestNeighborQuery.StringFilter

clear()

public NearestNeighborQuery.StringFilter.Builder clear()

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAllowTokens()

public NearestNeighborQuery.StringFilter.Builder clearAllowTokens()

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

clearDenyTokens()

public NearestNeighborQuery.StringFilter.Builder clearDenyTokens()

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

clearName()

public NearestNeighborQuery.StringFilter.Builder clearName()

Required. Column names in BigQuery that used as filters.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

getAllowTokens(int index)

public String getAllowTokens(int index)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowTokens at the given index.

getAllowTokensBytes(int index)

public ByteString getAllowTokensBytes(int index)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowTokens at the given index.

getAllowTokensCount()

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.

getAllowTokensList()

public ProtocolStringList getAllowTokensList()

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the allowTokens.

getDefaultInstanceForType()

public NearestNeighborQuery.StringFilter getDefaultInstanceForType()

Returns
Type	Description
NearestNeighborQuery.StringFilter

getDenyTokens(int index)

public String getDenyTokens(int index)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The denyTokens at the given index.

getDenyTokensBytes(int index)

public ByteString getDenyTokensBytes(int index)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the denyTokens at the given index.

getDenyTokensCount()

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.

getDenyTokensList()

public ProtocolStringList getDenyTokensList()

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the denyTokens.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Required. Column names in BigQuery that used as filters.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The name.

getNameBytes()

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(NearestNeighborQuery.StringFilter other)

public NearestNeighborQuery.StringFilter.Builder mergeFrom(NearestNeighborQuery.StringFilter other)

Parameter
Name	Description
other	NearestNeighborQuery.StringFilter

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NearestNeighborQuery.StringFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public NearestNeighborQuery.StringFilter.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

setAllowTokens(int index, String value)

public NearestNeighborQuery.StringFilter.Builder setAllowTokens(int index, String value)

Optional. The allowed tokens.

repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int The index to set the value at.
value	String The allowTokens to set.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

setDenyTokens(int index, String value)

public NearestNeighborQuery.StringFilter.Builder setDenyTokens(int index, String value)

Optional. The denied tokens.

repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int The index to set the value at.
value	String The denyTokens to set.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

setName(String value)

public NearestNeighborQuery.StringFilter.Builder setName(String value)

Required. Column names in BigQuery that used as filters.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.

setNameBytes(ByteString value)

public NearestNeighborQuery.StringFilter.Builder setNameBytes(ByteString value)

Required. Column names in BigQuery that used as filters.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder	This builder for chaining.