Cloud Firestore V1beta1 Client - Class Projection (2.2.0-RC1)

2.2.0-RC1 2.1.0 (latest) 2.0.2-RC1 1.55.0 1.54.4 1.53.1 1.52.0 1.51.0 1.50.0 1.48.1 1.47.3 1.46.0 1.45.2 1.44.1 1.43.3 1.40.0 1.39.0 1.38.0 1.37.7 1.36.1 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.28.0 1.27.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

The projection of document's fields to return.

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

Namespace

Google \ Cloud \ Firestore \ V1beta1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ fields	array<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
Type	Description
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
Name	Description
var	array<FieldReference>

Returns
Type	Description
$this