com.google.cloud.aiplatform.v1beta1

Class NearestNeighborQuery.StringFilter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.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.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NearestNeighborQuery.StringFilter.Builder String filter is used to search a subset of the entities by using boolean rules on string columns.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_TOKENS_FIELD_NUMBER
static int	DENY_TOKENS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAllowTokens(int index) Optional.
com.google.protobuf.ByteString	getAllowTokensBytes(int index) Optional.
int	getAllowTokensCount() Optional.
com.google.protobuf.ProtocolStringList	getAllowTokensList() Optional.
static NearestNeighborQuery.StringFilter	getDefaultInstance()
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()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<NearestNeighborQuery.StringFilter>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static NearestNeighborQuery.StringFilter.Builder	newBuilder()
static NearestNeighborQuery.StringFilter.Builder	newBuilder(NearestNeighborQuery.StringFilter prototype)
NearestNeighborQuery.StringFilter.Builder	newBuilderForType()
protected NearestNeighborQuery.StringFilter.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static NearestNeighborQuery.StringFilter	parseDelimitedFrom(InputStream input)
static NearestNeighborQuery.StringFilter	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.StringFilter	parseFrom(byte[] data)
static NearestNeighborQuery.StringFilter	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.StringFilter	parseFrom(ByteBuffer data)
static NearestNeighborQuery.StringFilter	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.StringFilter	parseFrom(com.google.protobuf.ByteString data)
static NearestNeighborQuery.StringFilter	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.StringFilter	parseFrom(com.google.protobuf.CodedInputStream input)
static NearestNeighborQuery.StringFilter	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NearestNeighborQuery.StringFilter	parseFrom(InputStream input)
static NearestNeighborQuery.StringFilter	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<NearestNeighborQuery.StringFilter>	parser()
NearestNeighborQuery.StringFilter.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_TOKENS_FIELD_NUMBER

public static final int ALLOW_TOKENS_FIELD_NUMBER

See Also:

Constant Field Values

DENY_TOKENS_FIELD_NUMBER

public static final int DENY_TOKENS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public NearestNeighborQuery.StringFilter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder