Class StructuredQuery.FieldReference.Builder (3.10.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.FieldReference.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

build()

public StructuredQuery.FieldReference build()
Returns
TypeDescription
StructuredQuery.FieldReference

buildPartial()

public StructuredQuery.FieldReference buildPartial()
Returns
TypeDescription
StructuredQuery.FieldReference

clear()

public StructuredQuery.FieldReference.Builder clear()
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StructuredQuery.FieldReference.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
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
TypeDescription
StructuredQuery.FieldReference.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredQuery.FieldReference.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

clone()

public StructuredQuery.FieldReference.Builder clone()
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
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
TypeDescription
ByteString

The bytes for fieldPath.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StructuredQuery.FieldReference other)

public StructuredQuery.FieldReference.Builder mergeFrom(StructuredQuery.FieldReference other)
Parameter
NameDescription
otherStructuredQuery.FieldReference
Returns
TypeDescription
StructuredQuery.FieldReference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredQuery.FieldReference.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StructuredQuery.FieldReference.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.FieldReference.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.FieldReference.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
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
NameDescription
valueString

The fieldPath to set.

Returns
TypeDescription
StructuredQuery.FieldReference.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for fieldPath to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.FieldReference.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides