Package com.google.cloud.aiplatform.v1

Class NearestNeighborQuery.StringFilter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<NearestNeighborQuery.StringFilter.Builder>
com.google.cloud.aiplatform.v1.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.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

  • 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.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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.