Cloud Firestore V1 Client - Class CreateDatabaseRequest (1.38.0)

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

The request for FirestoreAdmin.CreateDatabase.

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

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}
↳ database Google\Cloud\Firestore\Admin\V1\Database

Required. The Database to create.
↳ database_id string

Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".

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

getDatabase

Required. The Database to create.

Returns
Type Description
Google\Cloud\Firestore\Admin\V1\Database|null

hasDatabase

clearDatabase

setDatabase

Required. The Database to create.

Parameter
Name Description
var Google\Cloud\Firestore\Admin\V1\Database
Returns
Type Description
$this

getDatabaseId

Required. The ID to use for the database, which will become the final component of the database's resource name.

The value must be set to "(default)".

Returns
Type Description
string

setDatabaseId

Required. The ID to use for the database, which will become the final component of the database's resource name.

The value must be set to "(default)".

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
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.
database Google\Cloud\Firestore\Admin\V1\Database

Required. The Database to create.
databaseId string

Required. The ID to use for the database, which will become the final component of the database's resource name.

The value must be set to "(default)".
Returns
Type Description
Google\Cloud\Firestore\Admin\V1\CreateDatabaseRequest