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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredQuery.FieldReference.BuilderImplements
StructuredQuery.FieldReferenceOrBuilderStatic 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 |
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 |
clearField(Descriptors.FieldDescriptor field)
public StructuredQuery.FieldReference.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
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 | |
---|---|
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 |
clone()
public StructuredQuery.FieldReference.Builder clone()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
getDefaultInstanceForType()
public StructuredQuery.FieldReference getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
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 |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery.FieldReference.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
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 |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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 |
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery.FieldReference.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |