Cloud Firestore V1 Client - Class DeleteDatabaseRequest (1.44.1)

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

The request for FirestoreAdmin.DeleteDatabase.

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ etag string

The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

The current etag of the Database.

If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.

Returns
Type Description
string

setEtag

The current etag of the Database.

If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. A name of the form projects/{project_id}/databases/{database_id} Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::databaseName() for help formatting this field.

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