Class StructuredQuery.Filter (3.14.1)

public static final class StructuredQuery.Filter extends GeneratedMessageV3 implements StructuredQuery.FilterOrBuilder

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

Static Fields

COMPOSITE_FILTER_FIELD_NUMBER

public static final int COMPOSITE_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

FIELD_FILTER_FIELD_NUMBER

public static final int FIELD_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

UNARY_FILTER_FIELD_NUMBER

public static final int UNARY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(StructuredQuery.Filter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompositeFilter()

public StructuredQuery.CompositeFilter getCompositeFilter()

A composite filter.

.google.firestore.v1.StructuredQuery.CompositeFilter composite_filter = 1;

Returns
TypeDescription
StructuredQuery.CompositeFilter

The compositeFilter.

getCompositeFilterOrBuilder()

public StructuredQuery.CompositeFilterOrBuilder getCompositeFilterOrBuilder()

A composite filter.

.google.firestore.v1.StructuredQuery.CompositeFilter composite_filter = 1;

Returns
TypeDescription
StructuredQuery.CompositeFilterOrBuilder

getDefaultInstanceForType()

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

getFieldFilter()

public StructuredQuery.FieldFilter getFieldFilter()

A filter on a document field.

.google.firestore.v1.StructuredQuery.FieldFilter field_filter = 2;

Returns
TypeDescription
StructuredQuery.FieldFilter

The fieldFilter.

getFieldFilterOrBuilder()

public StructuredQuery.FieldFilterOrBuilder getFieldFilterOrBuilder()

A filter on a document field.

.google.firestore.v1.StructuredQuery.FieldFilter field_filter = 2;

Returns
TypeDescription
StructuredQuery.FieldFilterOrBuilder

getFilterTypeCase()

public StructuredQuery.Filter.FilterTypeCase getFilterTypeCase()
Returns
TypeDescription
StructuredQuery.Filter.FilterTypeCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnaryFilter()

public StructuredQuery.UnaryFilter getUnaryFilter()

A filter that takes exactly one argument.

.google.firestore.v1.StructuredQuery.UnaryFilter unary_filter = 3;

Returns
TypeDescription
StructuredQuery.UnaryFilter

The unaryFilter.

getUnaryFilterOrBuilder()

public StructuredQuery.UnaryFilterOrBuilder getUnaryFilterOrBuilder()

A filter that takes exactly one argument.

.google.firestore.v1.StructuredQuery.UnaryFilter unary_filter = 3;

Returns
TypeDescription
StructuredQuery.UnaryFilterOrBuilder

hasCompositeFilter()

public boolean hasCompositeFilter()

A composite filter.

.google.firestore.v1.StructuredQuery.CompositeFilter composite_filter = 1;

Returns
TypeDescription
boolean

Whether the compositeFilter field is set.

hasFieldFilter()

public boolean hasFieldFilter()

A filter on a document field.

.google.firestore.v1.StructuredQuery.FieldFilter field_filter = 2;

Returns
TypeDescription
boolean

Whether the fieldFilter field is set.

hasUnaryFilter()

public boolean hasUnaryFilter()

A filter that takes exactly one argument.

.google.firestore.v1.StructuredQuery.UnaryFilter unary_filter = 3;

Returns
TypeDescription
boolean

Whether the unaryFilter 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.Filter.Builder newBuilderForType()
Returns
TypeDescription
StructuredQuery.Filter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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