Reference documentation and code samples for the Cloud Firestore V1 Client class UpdateDatabaseRequest.
The request for FirestoreAdmin.UpdateDatabase.
Generated from protobuf message google.firestore.admin.v1.UpdateDatabaseRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
Google\Cloud\Firestore\Admin\V1\Database
Required. The database to update. |
↳ update_mask |
Google\Protobuf\FieldMask
The list of fields to be updated. |
getDatabase
Required. The database to update.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Database|null |
|
hasDatabase
clearDatabase
setDatabase
Required. The database to update.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Database
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateMask
The list of fields to be updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
The list of fields to be updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
database |
Google\Cloud\Firestore\Admin\V1\Database
Required. The database to update. |
updateMask |
Google\Protobuf\FieldMask
The list of fields to be updated. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\UpdateDatabaseRequest |
|