Cloud Firestore V1 Client - Class CreateDatabaseRequest (1.46.0)

Version 1.46.0

• 1.47.0 (latest)
• 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

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. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.

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.

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.

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.

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.

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. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\CreateDatabaseRequest