Package com.google.cloud.aiplatform.v1

Class NearestNeighborQuery.StringFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter
All Implemented Interfaces:
NearestNeighborQuery.StringFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
NearestNeighborQuery
public static final class NearestNeighborQuery.StringFilter extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

  • 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

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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NearestNeighborQuery.StringFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public NearestNeighborQuery.StringFilter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static NearestNeighborQuery.StringFilter.Builder newBuilder()

    • newBuilder

      public static NearestNeighborQuery.StringFilter.Builder newBuilder(NearestNeighborQuery.StringFilter prototype)

    • toBuilder

      public NearestNeighborQuery.StringFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected NearestNeighborQuery.StringFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static NearestNeighborQuery.StringFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NearestNeighborQuery.StringFilter> parser()

    • getParserForType

      public com.google.protobuf.Parser<NearestNeighborQuery.StringFilter> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public NearestNeighborQuery.StringFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder