public static final class StructuredQuery.Projection extends GeneratedMessageV3 implements StructuredQuery.ProjectionOrBuilder
The projection of document's fields to return.
Protobuf type google.firestore.v1.StructuredQuery.Projection
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredQuery.ProjectionImplements
StructuredQuery.ProjectionOrBuilderStatic Fields
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static StructuredQuery.Projection getDefaultInstance()
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static StructuredQuery.Projection.Builder newBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection.Builder |
newBuilder(StructuredQuery.Projection prototype)
public static StructuredQuery.Projection.Builder newBuilder(StructuredQuery.Projection prototype)
Parameter | |
---|---|
Name | Description |
prototype | StructuredQuery.Projection |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection.Builder |
parseDelimitedFrom(InputStream input)
public static StructuredQuery.Projection parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static StructuredQuery.Projection parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static StructuredQuery.Projection parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static StructuredQuery.Projection parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static StructuredQuery.Projection parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static StructuredQuery.Projection parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.Projection parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<StructuredQuery.Projection> parser()
Returns | |
---|---|
Type | Description |
Parser<Projection> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public StructuredQuery.Projection getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection |
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 |
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> |
getParserForType()
public Parser<StructuredQuery.Projection> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Projection> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public StructuredQuery.Projection.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredQuery.Projection.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public StructuredQuery.Projection.Builder toBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.Projection.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |