NearestNeighborQuery.StringFilter.Builder (proto-google-cloud-aiplatform-v1beta1 0.71.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
    - - com.google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter.Builder

All Implemented Interfaces:: NearestNeighborQuery.StringFilterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: NearestNeighborQuery.StringFilter

public static final class NearestNeighborQuery.StringFilter.Builder
extends com.google.protobuf.GeneratedMessageV3.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.v1beta1.NearestNeighborQuery.StringFilter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NearestNeighborQuery.StringFilter.Builder`	`addAllAllowTokens(Iterable<String> values)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addAllDenyTokens(Iterable<String> values)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addAllowTokens(String value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addAllowTokensBytes(com.google.protobuf.ByteString value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addDenyTokens(String value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addDenyTokensBytes(com.google.protobuf.ByteString value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`NearestNeighborQuery.StringFilter`	`build()`
`NearestNeighborQuery.StringFilter`	`buildPartial()`
`NearestNeighborQuery.StringFilter.Builder`	`clear()`
`NearestNeighborQuery.StringFilter.Builder`	`clearAllowTokens()` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`clearDenyTokens()` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`NearestNeighborQuery.StringFilter.Builder`	`clearName()` Required.
`NearestNeighborQuery.StringFilter.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`NearestNeighborQuery.StringFilter.Builder`	`clone()`
`String`	`getAllowTokens(int index)` Optional.
`com.google.protobuf.ByteString`	`getAllowTokensBytes(int index)` Optional.
`int`	`getAllowTokensCount()` Optional.
`com.google.protobuf.ProtocolStringList`	`getAllowTokensList()` Optional.
`NearestNeighborQuery.StringFilter`	`getDefaultInstanceForType()`
`String`	`getDenyTokens(int index)` Optional.
`com.google.protobuf.ByteString`	`getDenyTokensBytes(int index)` Optional.
`int`	`getDenyTokensCount()` Optional.
`com.google.protobuf.ProtocolStringList`	`getDenyTokensList()` Optional.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`NearestNeighborQuery.StringFilter.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`NearestNeighborQuery.StringFilter.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`NearestNeighborQuery.StringFilter.Builder`	`mergeFrom(NearestNeighborQuery.StringFilter other)`
`NearestNeighborQuery.StringFilter.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`NearestNeighborQuery.StringFilter.Builder`	`setAllowTokens(int index, String value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`setDenyTokens(int index, String value)` Optional.
`NearestNeighborQuery.StringFilter.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`NearestNeighborQuery.StringFilter.Builder`	`setName(String value)` Required.
`NearestNeighborQuery.StringFilter.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`NearestNeighborQuery.StringFilter.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`NearestNeighborQuery.StringFilter.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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, 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

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - clear
```
public NearestNeighborQuery.StringFilter.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.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.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.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - getDefaultInstanceForType
```
public NearestNeighborQuery.StringFilter getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public NearestNeighborQuery.StringFilter build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public NearestNeighborQuery.StringFilter buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public NearestNeighborQuery.StringFilter.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - setField
```
public NearestNeighborQuery.StringFilter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - clearField
```
public NearestNeighborQuery.StringFilter.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - clearOneof
```
public NearestNeighborQuery.StringFilter.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - setRepeatedField
```
public NearestNeighborQuery.StringFilter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  int index,
                                                                  Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - addRepeatedField
```
public NearestNeighborQuery.StringFilter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - mergeFrom
```
public NearestNeighborQuery.StringFilter.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<NearestNeighborQuery.StringFilter.Builder>
  - mergeFrom
```
public NearestNeighborQuery.StringFilter.Builder mergeFrom(NearestNeighborQuery.StringFilter other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - mergeFrom
```
public NearestNeighborQuery.StringFilter.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<NearestNeighborQuery.StringFilter.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 Required. Column names in BigQuery that used as filters.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getName in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Required. Column names in BigQuery that used as filters.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getNameBytes in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public NearestNeighborQuery.StringFilter.Builder setName(String value)
```
```
 Required. Column names in BigQuery that used as filters.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    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:
    
    This builder for chaining.
  - setNameBytes
```
public NearestNeighborQuery.StringFilter.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 Required. Column names in BigQuery that used as filters.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getAllowTokensList
```
public com.google.protobuf.ProtocolStringList getAllowTokensList()
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getAllowTokensList in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    A list containing the allowTokens.
  - getAllowTokensCount
```
public int getAllowTokensCount()
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getAllowTokensCount in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    The count of allowTokens.
  - getAllowTokens
```
public String getAllowTokens(int index)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getAllowTokens in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The allowTokens at the given index.
  - getAllowTokensBytes
```
public com.google.protobuf.ByteString getAllowTokensBytes(int index)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getAllowTokensBytes in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the allowTokens at the given index.
  - setAllowTokens
```
public NearestNeighborQuery.StringFilter.Builder setAllowTokens(int index,
                                                                String value)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index to set the value at.
    
    value - The allowTokens to set.
    
    Returns:
    
    This builder for chaining.
  - addAllowTokens
```
public NearestNeighborQuery.StringFilter.Builder addAllowTokens(String value)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The allowTokens to add.
    
    Returns:
    
    This builder for chaining.
  - addAllAllowTokens
```
public NearestNeighborQuery.StringFilter.Builder addAllAllowTokens(Iterable<String> values)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    values - The allowTokens to add.
    
    Returns:
    
    This builder for chaining.
  - clearAllowTokens
```
public NearestNeighborQuery.StringFilter.Builder clearAllowTokens()
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - addAllowTokensBytes
```
public NearestNeighborQuery.StringFilter.Builder addAllowTokensBytes(com.google.protobuf.ByteString value)
```
```
 Optional. The allowed tokens.
 
```
    repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes of the allowTokens to add.
    
    Returns:
    
    This builder for chaining.
  - getDenyTokensList
```
public com.google.protobuf.ProtocolStringList getDenyTokensList()
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDenyTokensList in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    A list containing the denyTokens.
  - getDenyTokensCount
```
public int getDenyTokensCount()
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDenyTokensCount in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Returns:
    
    The count of denyTokens.
  - getDenyTokens
```
public String getDenyTokens(int index)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDenyTokens in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The denyTokens at the given index.
  - getDenyTokensBytes
```
public com.google.protobuf.ByteString getDenyTokensBytes(int index)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDenyTokensBytes in interface NearestNeighborQuery.StringFilterOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the denyTokens at the given index.
  - setDenyTokens
```
public NearestNeighborQuery.StringFilter.Builder setDenyTokens(int index,
                                                               String value)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index to set the value at.
    
    value - The denyTokens to set.
    
    Returns:
    
    This builder for chaining.
  - addDenyTokens
```
public NearestNeighborQuery.StringFilter.Builder addDenyTokens(String value)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The denyTokens to add.
    
    Returns:
    
    This builder for chaining.
  - addAllDenyTokens
```
public NearestNeighborQuery.StringFilter.Builder addAllDenyTokens(Iterable<String> values)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    values - The denyTokens to add.
    
    Returns:
    
    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:
    
    This builder for chaining.
  - addDenyTokensBytes
```
public NearestNeighborQuery.StringFilter.Builder addDenyTokensBytes(com.google.protobuf.ByteString value)
```
```
 Optional. The denied tokens.
 
```
    repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes of the denyTokens to add.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final NearestNeighborQuery.StringFilter.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>
  - mergeUnknownFields
```
public final NearestNeighborQuery.StringFilter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.StringFilter.Builder>

Class NearestNeighborQuery.StringFilter.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getAllowTokensList

getAllowTokensCount

getAllowTokens

getAllowTokensBytes

setAllowTokens

addAllowTokens

addAllAllowTokens

clearAllowTokens

addAllowTokensBytes

getDenyTokensList

getDenyTokensCount

getDenyTokens

getDenyTokensBytes

setDenyTokens

addDenyTokens

addAllDenyTokens

clearDenyTokens

addDenyTokensBytes

setUnknownFields

mergeUnknownFields