Class StructuredQuery.FieldReference.Builder (3.5.0)
3.43.1 (latest)
3.41.0
3.38.0
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
3.27.2
3.26.5
3.25.1
3.24.3
3.22.0
3.21.4
3.20.0
3.17.0
3.16.3
3.15.7
3.14.4
3.13.2
3.12.1
3.11.0
3.10.0
3.9.6
3.8.2
3.7.10
3.6.0
3.5.0
3.4.2
3.3.0
3.2.0
3.1.0
3.0.21
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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredQuery . FieldReference . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
build()
public StructuredQuery . FieldReference build ()
Returns
buildPartial()
public StructuredQuery . FieldReference buildPartial ()
Returns
clear()
public StructuredQuery . FieldReference . Builder clear ()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public StructuredQuery . FieldReference . Builder clearField ( Descriptors . FieldDescriptor field )
Parameter
Returns
Overrides
clearFieldPath()
public StructuredQuery . FieldReference . Builder clearFieldPath ()
The relative path of the document being referenced.
Requires:
Conform to document field name limitations.
string field_path = 2;
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredQuery . FieldReference . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Parameter
Returns
Overrides
clone()
public StructuredQuery . FieldReference . Builder clone ()
Returns
Overrides
getDefaultInstanceForType()
public StructuredQuery . FieldReference getDefaultInstanceForType ()
Returns
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Returns
Overrides
getFieldPath()
public String getFieldPath ()
The relative path of the document being referenced.
Requires:
Conform to document field name limitations.
string field_path = 2;
Returns
Type Description
String The fieldPath.
getFieldPathBytes()
public ByteString getFieldPathBytes ()
The relative path of the document being referenced.
Requires:
Conform to document field name limitations.
string field_path = 2;
Returns
Type Description
ByteString The bytes for fieldPath.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
mergeFrom(StructuredQuery.FieldReference other)
public StructuredQuery . FieldReference . Builder mergeFrom ( StructuredQuery . FieldReference other )
Parameter
Returns
public StructuredQuery . FieldReference . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public StructuredQuery . FieldReference . Builder mergeFrom ( Message other )
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery . FieldReference . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredQuery . FieldReference . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
setFieldPath(String value)
public StructuredQuery . FieldReference . Builder setFieldPath ( String value )
The relative path of the document being referenced.
Requires:
Conform to document field name limitations.
string field_path = 2;
Parameter
Name Description
value String The fieldPath to set.
Returns
setFieldPathBytes(ByteString value)
public StructuredQuery . FieldReference . Builder setFieldPathBytes ( ByteString value )
The relative path of the document being referenced.
Requires:
Conform to document field name limitations.
string field_path = 2;
Parameter
Name Description
value ByteString The bytes for fieldPath to set.
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredQuery . FieldReference . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery . FieldReference . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-18 UTC."],[],[]]
