Class NearestNeighborQuery.StringFilter.Builder (3.31.0)

Version 3.31.0

• 3.42.0 (latest)
• 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 GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder> implements NearestNeighborQuery.StringFilterOrBuilder

String filter is used to search a subset of the entities by using boolean rules. 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.v1beta1.NearestNeighborQuery.StringFilter

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.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)

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

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.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

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

GeneratedMessageV3.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.

clearField(Descriptors.FieldDescriptor field)

public NearestNeighborQuery.StringFilter.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public NearestNeighborQuery.StringFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

clone()

public NearestNeighborQuery.StringFilter.Builder clone()

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.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 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(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)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.StringFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

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.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

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.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NearestNeighborQuery.StringFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.StringFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

Overrides

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