- 3.48.0 (latest)
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
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 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NearestNeighborQuery.StringFilterImplements
NearestNeighborQuery.StringFilterOrBuilderStatic Fields
ALLOW_TOKENS_FIELD_NUMBER
public static final int ALLOW_TOKENS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DENY_TOKENS_FIELD_NUMBER
public static final int DENY_TOKENS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static NearestNeighborQuery.StringFilter getDefaultInstance()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static NearestNeighborQuery.StringFilter.Builder newBuilder()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter.Builder |
newBuilder(NearestNeighborQuery.StringFilter prototype)
public static NearestNeighborQuery.StringFilter.Builder newBuilder(NearestNeighborQuery.StringFilter prototype)
Parameter | |
---|---|
Name | Description |
prototype |
NearestNeighborQuery.StringFilter |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter.Builder |
parseDelimitedFrom(InputStream input)
public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static NearestNeighborQuery.StringFilter parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NearestNeighborQuery.StringFilter parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NearestNeighborQuery.StringFilter parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static NearestNeighborQuery.StringFilter parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.StringFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<NearestNeighborQuery.StringFilter> parser()
Returns | |
---|---|
Type | Description |
Parser<StringFilter> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getAllowTokens(int index)
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. |
getAllowTokensBytes(int 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. |
getAllowTokensCount()
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. |
getAllowTokensList()
public ProtocolStringList getAllowTokensList()
Optional. The allowed tokens.
repeated string allow_tokens = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the allowTokens. |
getDefaultInstanceForType()
public NearestNeighborQuery.StringFilter getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter |
getDenyTokens(int index)
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. |
getDenyTokensBytes(int 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. |
getDenyTokensCount()
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. |
getDenyTokensList()
public ProtocolStringList getDenyTokensList()
Optional. The denied tokens.
repeated string deny_tokens = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the denyTokens. |
getName()
public String getName()
Required. Column names in BigQuery that used as filters.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
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. |
getParserForType()
public Parser<NearestNeighborQuery.StringFilter> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<StringFilter> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public NearestNeighborQuery.StringFilter.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NearestNeighborQuery.StringFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public NearestNeighborQuery.StringFilter.Builder toBuilder()
Returns | |
---|---|
Type | Description |
NearestNeighborQuery.StringFilter.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |