Cloud Firestore V1 Client - Class Projection (1.34.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Projection.

The projection of document's fields to return.

Generated from protobuf message google.firestore.v1.StructuredQuery.Projection

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ fields array<Google\Cloud\Firestore\V1\StructuredQuery\FieldReference>

The fields to return. If empty, all fields are returned. To only return the name of the document, use ['__name__'].

getFields

The fields to return.

If empty, all fields are returned. To only return the name of the document, use ['__name__'].

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFields

The fields to return.

If empty, all fields are returned. To only return the name of the document, use ['__name__'].

Parameter
NameDescription
var array<Google\Cloud\Firestore\V1\StructuredQuery\FieldReference>
Returns
TypeDescription
$this