Class StructuredQuery.FieldFilter (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

OP_FIELD_NUMBER

public static final int OP_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredQuery.FieldFilter getDefaultInstance()
Returns
TypeDescription
StructuredQuery.FieldFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StructuredQuery.FieldFilter.Builder newBuilder()
Returns
TypeDescription
StructuredQuery.FieldFilter.Builder

newBuilder(StructuredQuery.FieldFilter prototype)

public static StructuredQuery.FieldFilter.Builder newBuilder(StructuredQuery.FieldFilter prototype)
Parameter
NameDescription
prototypeStructuredQuery.FieldFilter
Returns
TypeDescription
StructuredQuery.FieldFilter.Builder

parseDelimitedFrom(InputStream input)

public static StructuredQuery.FieldFilter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StructuredQuery.FieldFilter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredQuery.FieldFilter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredQuery.FieldFilter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StructuredQuery.FieldFilter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StructuredQuery.FieldFilter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredQuery.FieldFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StructuredQuery.FieldFilter getDefaultInstanceForType()
Returns
TypeDescription
StructuredQuery.FieldFilter

getField()

public StructuredQuery.FieldReference getField()

The field to filter by.

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

Returns
TypeDescription
StructuredQuery.FieldReference

The field.

getFieldOrBuilder()

public StructuredQuery.FieldReferenceOrBuilder getFieldOrBuilder()

The field to filter by.

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

Returns
TypeDescription
StructuredQuery.FieldReferenceOrBuilder

getOp()

public StructuredQuery.FieldFilter.Operator getOp()

The operator to filter by.

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

Returns
TypeDescription
StructuredQuery.FieldFilter.Operator

The op.

getOpValue()

public int getOpValue()

The operator to filter by.

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

Returns
TypeDescription
int

The enum numeric value on the wire for op.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValue()

public Value getValue()

The value to compare to.

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

Returns
TypeDescription
Value

The value.

getValueOrBuilder()

public ValueOrBuilder getValueOrBuilder()

The value to compare to.

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

Returns
TypeDescription
ValueOrBuilder

hasField()

public boolean hasField()

The field to filter by.

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

Returns
TypeDescription
boolean

Whether the field field is set.

hasValue()

public boolean hasValue()

The value to compare to.

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

Returns
TypeDescription
boolean

Whether the value field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StructuredQuery.FieldFilter.Builder newBuilderForType()
Returns
TypeDescription
StructuredQuery.FieldFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredQuery.FieldFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StructuredQuery.FieldFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StructuredQuery.FieldFilter.Builder toBuilder()
Returns
TypeDescription
StructuredQuery.FieldFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException