public static final class NearestNeighborQuery.StringFilter extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ALLOW_TOKENS_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
public static final int DENY_TOKENS_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
public static NearestNeighborQuery.StringFilter getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static NearestNeighborQuery.StringFilter.Builder newBuilder()
public static NearestNeighborQuery.StringFilter.Builder newBuilder(NearestNeighborQuery.StringFilter prototype)
public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input)
public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
public static NearestNeighborQuery.StringFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(ByteString data)
public static NearestNeighborQuery.StringFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(CodedInputStream input)
public static NearestNeighborQuery.StringFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(InputStream input)
public static NearestNeighborQuery.StringFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data)
public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<NearestNeighborQuery.StringFilter> parser()
Methods
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
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.
|
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.
|
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.
|
public ProtocolStringList getAllowTokensList()
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
public NearestNeighborQuery.StringFilter getDefaultInstanceForType()
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.
|
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.
|
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.
|
public ProtocolStringList getDenyTokensList()
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Required. Column names in BigQuery that used as filters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns |
---|
Type | Description |
String | The name.
|
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.
|
public Parser<NearestNeighborQuery.StringFilter> getParserForType()
Overrides
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
Returns |
---|
Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public NearestNeighborQuery.StringFilter.Builder newBuilderForType()
protected NearestNeighborQuery.StringFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public NearestNeighborQuery.StringFilter.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides