Class StructuredQuery.Filter.Builder (3.22.0)

public static final class StructuredQuery.Filter.Builder extends GeneratedMessageV3.Builder<StructuredQuery.Filter.Builder> implements StructuredQuery.FilterOrBuilder

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.Filter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

build()

public StructuredQuery.Filter build()
Returns
Type Description
StructuredQuery.Filter

buildPartial()

public StructuredQuery.Filter buildPartial()
Returns
Type Description
StructuredQuery.Filter

clear()

public StructuredQuery.Filter.Builder clear()
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

clearCompositeFilter()

public StructuredQuery.Filter.Builder clearCompositeFilter()

A composite filter.

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

Returns
Type Description
StructuredQuery.Filter.Builder

clearField(Descriptors.FieldDescriptor field)

public StructuredQuery.Filter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

clearFieldFilter()

public StructuredQuery.Filter.Builder clearFieldFilter()

A filter on a document field.

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

Returns
Type Description
StructuredQuery.Filter.Builder

clearFilterType()

public StructuredQuery.Filter.Builder clearFilterType()
Returns
Type Description
StructuredQuery.Filter.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredQuery.Filter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

clearUnaryFilter()

public StructuredQuery.Filter.Builder clearUnaryFilter()

A filter that takes exactly one argument.

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

Returns
Type Description
StructuredQuery.Filter.Builder

clone()

public StructuredQuery.Filter.Builder clone()
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

getCompositeFilter()

public StructuredQuery.CompositeFilter getCompositeFilter()

A composite filter.

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

Returns
Type Description
StructuredQuery.CompositeFilter

The compositeFilter.

getCompositeFilterBuilder()

public StructuredQuery.CompositeFilter.Builder getCompositeFilterBuilder()

A composite filter.

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

Returns
Type Description
StructuredQuery.CompositeFilter.Builder

getCompositeFilterOrBuilder()

public StructuredQuery.CompositeFilterOrBuilder getCompositeFilterOrBuilder()

A composite filter.

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

Returns
Type Description
StructuredQuery.CompositeFilterOrBuilder

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFieldFilter()

public StructuredQuery.FieldFilter getFieldFilter()

A filter on a document field.

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

Returns
Type Description
StructuredQuery.FieldFilter

The fieldFilter.

getFieldFilterBuilder()

public StructuredQuery.FieldFilter.Builder getFieldFilterBuilder()

A filter on a document field.

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

Returns
Type Description
StructuredQuery.FieldFilter.Builder

getFieldFilterOrBuilder()

public StructuredQuery.FieldFilterOrBuilder getFieldFilterOrBuilder()

A filter on a document field.

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

Returns
Type Description
StructuredQuery.FieldFilterOrBuilder

getFilterTypeCase()

public StructuredQuery.Filter.FilterTypeCase getFilterTypeCase()
Returns
Type Description
StructuredQuery.Filter.FilterTypeCase

getUnaryFilter()

public StructuredQuery.UnaryFilter getUnaryFilter()

A filter that takes exactly one argument.

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

Returns
Type Description
StructuredQuery.UnaryFilter

The unaryFilter.

getUnaryFilterBuilder()

public StructuredQuery.UnaryFilter.Builder getUnaryFilterBuilder()

A filter that takes exactly one argument.

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

Returns
Type Description
StructuredQuery.UnaryFilter.Builder

getUnaryFilterOrBuilder()

public StructuredQuery.UnaryFilterOrBuilder getUnaryFilterOrBuilder()

A filter that takes exactly one argument.

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

Returns
Type Description
StructuredQuery.UnaryFilterOrBuilder

hasCompositeFilter()

public boolean hasCompositeFilter()

A composite filter.

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

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the unaryFilter field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompositeFilter(StructuredQuery.CompositeFilter value)

public StructuredQuery.Filter.Builder mergeCompositeFilter(StructuredQuery.CompositeFilter value)

A composite filter.

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

Parameter
Name Description
value StructuredQuery.CompositeFilter
Returns
Type Description
StructuredQuery.Filter.Builder

mergeFieldFilter(StructuredQuery.FieldFilter value)

public StructuredQuery.Filter.Builder mergeFieldFilter(StructuredQuery.FieldFilter value)

A filter on a document field.

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

Parameter
Name Description
value StructuredQuery.FieldFilter
Returns
Type Description
StructuredQuery.Filter.Builder

mergeFrom(StructuredQuery.Filter other)

public StructuredQuery.Filter.Builder mergeFrom(StructuredQuery.Filter other)
Parameter
Name Description
other StructuredQuery.Filter
Returns
Type Description
StructuredQuery.Filter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredQuery.Filter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StructuredQuery.Filter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

mergeUnaryFilter(StructuredQuery.UnaryFilter value)

public StructuredQuery.Filter.Builder mergeUnaryFilter(StructuredQuery.UnaryFilter value)

A filter that takes exactly one argument.

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

Parameter
Name Description
value StructuredQuery.UnaryFilter
Returns
Type Description
StructuredQuery.Filter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.Filter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

setCompositeFilter(StructuredQuery.CompositeFilter value)

public StructuredQuery.Filter.Builder setCompositeFilter(StructuredQuery.CompositeFilter value)

A composite filter.

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

Parameter
Name Description
value StructuredQuery.CompositeFilter
Returns
Type Description
StructuredQuery.Filter.Builder

setCompositeFilter(StructuredQuery.CompositeFilter.Builder builderForValue)

public StructuredQuery.Filter.Builder setCompositeFilter(StructuredQuery.CompositeFilter.Builder builderForValue)

A composite filter.

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

Parameter
Name Description
builderForValue StructuredQuery.CompositeFilter.Builder
Returns
Type Description
StructuredQuery.Filter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.Filter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

setFieldFilter(StructuredQuery.FieldFilter value)

public StructuredQuery.Filter.Builder setFieldFilter(StructuredQuery.FieldFilter value)

A filter on a document field.

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

Parameter
Name Description
value StructuredQuery.FieldFilter
Returns
Type Description
StructuredQuery.Filter.Builder

setFieldFilter(StructuredQuery.FieldFilter.Builder builderForValue)

public StructuredQuery.Filter.Builder setFieldFilter(StructuredQuery.FieldFilter.Builder builderForValue)

A filter on a document field.

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

Parameter
Name Description
builderForValue StructuredQuery.FieldFilter.Builder
Returns
Type Description
StructuredQuery.Filter.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StructuredQuery.Filter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides

setUnaryFilter(StructuredQuery.UnaryFilter value)

public StructuredQuery.Filter.Builder setUnaryFilter(StructuredQuery.UnaryFilter value)

A filter that takes exactly one argument.

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

Parameter
Name Description
value StructuredQuery.UnaryFilter
Returns
Type Description
StructuredQuery.Filter.Builder

setUnaryFilter(StructuredQuery.UnaryFilter.Builder builderForValue)

public StructuredQuery.Filter.Builder setUnaryFilter(StructuredQuery.UnaryFilter.Builder builderForValue)

A filter that takes exactly one argument.

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

Parameter
Name Description
builderForValue StructuredQuery.UnaryFilter.Builder
Returns
Type Description
StructuredQuery.Filter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.Filter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredQuery.Filter.Builder
Overrides