Class StructuredQuery.FieldFilter.Builder (3.21.0)

public static final class StructuredQuery.FieldFilter.Builder extends GeneratedMessageV3.Builder<StructuredQuery.FieldFilter.Builder> implements StructuredQuery.FieldFilterOrBuilder

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField()

public StructuredQuery.FieldFilter.Builder clearField()

The field to filter by.

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

Returns
Type Description
StructuredQuery.FieldFilter.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOp()

public StructuredQuery.FieldFilter.Builder clearOp()

The operator to filter by.

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

Returns
Type Description
StructuredQuery.FieldFilter.Builder

This builder for chaining.

clearValue()

public StructuredQuery.FieldFilter.Builder clearValue()

The value to compare to.

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

Returns
Type Description
StructuredQuery.FieldFilter.Builder

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

getField()

public StructuredQuery.FieldReference getField()

The field to filter by.

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

Returns
Type Description
StructuredQuery.FieldReference

The field.

getFieldBuilder()

public StructuredQuery.FieldReference.Builder getFieldBuilder()

The field to filter by.

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

Returns
Type Description
StructuredQuery.FieldReference.Builder

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.

getValue()

public Value getValue()

The value to compare to.

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

Returns
Type Description
Value

The value.

getValueBuilder()

public Value.Builder getValueBuilder()

The value to compare to.

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

Returns
Type Description
Value.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeField(StructuredQuery.FieldReference value)

public StructuredQuery.FieldFilter.Builder mergeField(StructuredQuery.FieldReference value)

The field to filter by.

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

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

mergeFrom(StructuredQuery.FieldFilter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeValue(Value value)

public StructuredQuery.FieldFilter.Builder mergeValue(Value value)

The value to compare to.

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

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

setField(StructuredQuery.FieldReference value)

public StructuredQuery.FieldFilter.Builder setField(StructuredQuery.FieldReference value)

The field to filter by.

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

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

setField(StructuredQuery.FieldReference.Builder builderForValue)

public StructuredQuery.FieldFilter.Builder setField(StructuredQuery.FieldReference.Builder builderForValue)

The field to filter by.

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

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setOp(StructuredQuery.FieldFilter.Operator value)

public StructuredQuery.FieldFilter.Builder setOp(StructuredQuery.FieldFilter.Operator value)

The operator to filter by.

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

Parameter
Name Description
value StructuredQuery.FieldFilter.Operator

The op to set.

Returns
Type Description
StructuredQuery.FieldFilter.Builder

This builder for chaining.

setOpValue(int value)

public StructuredQuery.FieldFilter.Builder setOpValue(int value)

The operator to filter by.

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

Parameter
Name Description
value int

The enum numeric value on the wire for op to set.

Returns
Type Description
StructuredQuery.FieldFilter.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setValue(Value value)

public StructuredQuery.FieldFilter.Builder setValue(Value value)

The value to compare to.

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

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

setValue(Value.Builder builderForValue)

public StructuredQuery.FieldFilter.Builder setValue(Value.Builder builderForValue)

The value to compare to.

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

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