Class StructuredQuery.FieldFilter (3.21.3)

public static final class StructuredQuery.FieldFilter extends GeneratedMessageV3 implements StructuredQuery.FieldFilterOrBuilder

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

OP_FIELD_NUMBER

public static final int OP_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StructuredQuery.FieldFilter getDefaultInstance()
Returns
Type Description
StructuredQuery.FieldFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StructuredQuery.FieldFilter.Builder newBuilder()
Returns
Type Description
StructuredQuery.FieldFilter.Builder

newBuilder(StructuredQuery.FieldFilter prototype)

public static StructuredQuery.FieldFilter.Builder newBuilder(StructuredQuery.FieldFilter prototype)
Parameter
Name Description
prototype StructuredQuery.FieldFilter
Returns
Type Description
StructuredQuery.FieldFilter.Builder

parseDelimitedFrom(InputStream input)

public static StructuredQuery.FieldFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StructuredQuery.FieldFilter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredQuery.FieldFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredQuery.FieldFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StructuredQuery.FieldFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StructuredQuery.FieldFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.FieldFilter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StructuredQuery.FieldFilter> parser()
Returns
Type Description
Parser<FieldFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public StructuredQuery.FieldFilter getDefaultInstanceForType()
Returns
Type Description
StructuredQuery.FieldFilter

getField()

public StructuredQuery.FieldReference getField()

The field to filter by.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
StructuredQuery.FieldReference

The field.

getFieldOrBuilder()

public StructuredQuery.FieldReferenceOrBuilder getFieldOrBuilder()

The field to filter by.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
StructuredQuery.FieldReferenceOrBuilder

getOp()

public StructuredQuery.FieldFilter.Operator getOp()

The operator to filter by.

.google.firestore.v1.StructuredQuery.FieldFilter.Operator op = 2;

Returns
Type Description
StructuredQuery.FieldFilter.Operator

The op.

getOpValue()

public int getOpValue()

The operator to filter by.

.google.firestore.v1.StructuredQuery.FieldFilter.Operator op = 2;

Returns
Type Description
int

The enum numeric value on the wire for op.

getParserForType()

public Parser<StructuredQuery.FieldFilter> getParserForType()
Returns
Type Description
Parser<FieldFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValue()

public Value getValue()

The value to compare to.

.google.firestore.v1.Value value = 3;

Returns
Type Description
Value

The value.

getValueOrBuilder()

public ValueOrBuilder getValueOrBuilder()

The value to compare to.

.google.firestore.v1.Value value = 3;

Returns
Type Description
ValueOrBuilder

hasField()

public boolean hasField()

The field to filter by.

.google.firestore.v1.StructuredQuery.FieldReference field = 1;

Returns
Type Description
boolean

Whether the field field is set.

hasValue()

public boolean hasValue()

The value to compare to.

.google.firestore.v1.Value value = 3;

Returns
Type Description
boolean

Whether the value field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StructuredQuery.FieldFilter.Builder newBuilderForType()
Returns
Type Description
StructuredQuery.FieldFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredQuery.FieldFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StructuredQuery.FieldFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StructuredQuery.FieldFilter.Builder toBuilder()
Returns
Type Description
StructuredQuery.FieldFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException