Cloud Firestore V1 Client - Class CollectionSelector (1.40.0)

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

A selection of a collection, such as messages as m1.

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

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ collection_id string

The collection ID. When set, selects only collections with this ID.

↳ all_descendants bool

When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.

getCollectionId

The collection ID.

When set, selects only collections with this ID.

Returns
TypeDescription
string

setCollectionId

The collection ID.

When set, selects only collections with this ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAllDescendants

When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest.

When true, selects all descendant collections.

Returns
TypeDescription
bool

setAllDescendants

When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest.

When true, selects all descendant collections.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this