public static final class StructuredQuery.Projection.Builder extends GeneratedMessage.Builder<StructuredQuery.Projection.Builder> implements StructuredQuery.ProjectionOrBuilderThe projection of document's fields to return.
Protobuf type google.firestore.v1.StructuredQuery.Projection
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > StructuredQuery.Projection.BuilderImplements
StructuredQuery.ProjectionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllFields(Iterable<? extends StructuredQuery.FieldReference> values)
public StructuredQuery.Projection.Builder addAllFields(Iterable<? extends StructuredQuery.FieldReference> values)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.firestore.v1.StructuredQuery.FieldReference> |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
addFields(StructuredQuery.FieldReference value)
public StructuredQuery.Projection.Builder addFields(StructuredQuery.FieldReference value)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredQuery.FieldReference |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
addFields(StructuredQuery.FieldReference.Builder builderForValue)
public StructuredQuery.Projection.Builder addFields(StructuredQuery.FieldReference.Builder builderForValue)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StructuredQuery.FieldReference.Builder |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
addFields(int index, StructuredQuery.FieldReference value)
public StructuredQuery.Projection.Builder addFields(int index, StructuredQuery.FieldReference value)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
StructuredQuery.FieldReference |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
addFields(int index, StructuredQuery.FieldReference.Builder builderForValue)
public StructuredQuery.Projection.Builder addFields(int index, StructuredQuery.FieldReference.Builder builderForValue)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
StructuredQuery.FieldReference.Builder |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
addFieldsBuilder()
public StructuredQuery.FieldReference.Builder addFieldsBuilder()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReference.Builder |
|
addFieldsBuilder(int index)
public StructuredQuery.FieldReference.Builder addFieldsBuilder(int index)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReference.Builder |
|
build()
public StructuredQuery.Projection build()| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection |
|
buildPartial()
public StructuredQuery.Projection buildPartial()| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection |
|
clear()
public StructuredQuery.Projection.Builder clear()| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
clearFields()
public StructuredQuery.Projection.Builder clearFields()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
getDefaultInstanceForType()
public StructuredQuery.Projection getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFields(int index)
public StructuredQuery.FieldReference getFields(int index)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReference |
|
getFieldsBuilder(int index)
public StructuredQuery.FieldReference.Builder getFieldsBuilder(int index)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReference.Builder |
|
getFieldsBuilderList()
public List<StructuredQuery.FieldReference.Builder> getFieldsBuilderList()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getFieldsCount()
public int getFieldsCount()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFieldsList()
public List<StructuredQuery.FieldReference> getFieldsList()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
List<FieldReference> |
|
getFieldsOrBuilder(int index)
public StructuredQuery.FieldReferenceOrBuilder getFieldsOrBuilder(int index)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReferenceOrBuilder |
|
getFieldsOrBuilderList()
public List<? extends StructuredQuery.FieldReferenceOrBuilder> getFieldsOrBuilderList()The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.firestore.v1.StructuredQuery.FieldReferenceOrBuilder> |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(StructuredQuery.Projection other)
public StructuredQuery.Projection.Builder mergeFrom(StructuredQuery.Projection other)| Parameter | |
|---|---|
| Name | Description |
other |
StructuredQuery.Projection |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StructuredQuery.Projection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public StructuredQuery.Projection.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
removeFields(int index)
public StructuredQuery.Projection.Builder removeFields(int index)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
setFields(int index, StructuredQuery.FieldReference value)
public StructuredQuery.Projection.Builder setFields(int index, StructuredQuery.FieldReference value)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
StructuredQuery.FieldReference |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|
setFields(int index, StructuredQuery.FieldReference.Builder builderForValue)
public StructuredQuery.Projection.Builder setFields(int index, StructuredQuery.FieldReference.Builder builderForValue)The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ['name'].
repeated .google.firestore.v1.StructuredQuery.FieldReference fields = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
StructuredQuery.FieldReference.Builder |
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.Projection.Builder |
|