Cloud Firestore V1 Client - Class ListDatabasesRequest (1.46.0)

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

A request to list the Firestore Databases in all locations for a project.

Generated from protobuf message google.firestore.admin.v1.ListDatabasesRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. A parent name of the form projects/{project_id}
↳ show_deleted bool

If true, also returns deleted resources.

getParent

Required. A parent name of the form projects/{project_id}

Returns
Type Description
string

setParent

Required. A parent name of the form projects/{project_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

If true, also returns deleted resources.

Returns
Type Description
bool

setShowDeleted

If true, also returns deleted resources.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. A parent name of the form projects/{project_id} Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::projectName() for help formatting this field.
Returns
Type Description
Google\Cloud\Firestore\Admin\V1\ListDatabasesRequest