Class StructuredQuery.FieldReference.Builder (3.21.1)

public static final class StructuredQuery.FieldReference.Builder extends GeneratedMessageV3.Builder<StructuredQuery.FieldReference.Builder> implements StructuredQuery.FieldReferenceOrBuilder

A reference to a field in a document, ex: stats.operations.

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFieldPath()

public StructuredQuery.FieldReference.Builder clearFieldPath()

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

string field_path = 2;

Returns
Type Description
StructuredQuery.FieldReference.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

getFieldPath()

public String getFieldPath()

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

string field_path = 2;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

string field_path = 2;

Returns
Type Description
ByteString

The bytes for fieldPath.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StructuredQuery.FieldReference other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldPath(String value)

public StructuredQuery.FieldReference.Builder setFieldPath(String value)

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

string field_path = 2;

Parameter
Name Description
value String

The fieldPath to set.

Returns
Type Description
StructuredQuery.FieldReference.Builder

This builder for chaining.

setFieldPathBytes(ByteString value)

public StructuredQuery.FieldReference.Builder setFieldPathBytes(ByteString value)

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

string field_path = 2;

Parameter
Name Description
value ByteString

The bytes for fieldPath to set.

Returns
Type Description
StructuredQuery.FieldReference.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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