Reference documentation and code samples for the Cloud Firestore V1 Client class RestoreDatabaseMetadata.
Metadata for the long-running operation from the RestoreDatabase request.
Generated from protobuf message google.firestore.admin.v1.RestoreDatabaseMetadata
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
The time the restore was started. |
↳ end_time |
Google\Protobuf\Timestamp
The time the restore finished, unset for ongoing restores. |
↳ operation_state |
int
The operation state of the restore. |
↳ database |
string
The name of the database being restored to. |
↳ backup |
string
The name of the backup restoring from. |
↳ progress_percentage |
Progress
How far along the restore is as an estimated percentage of remaining time. |
getStartTime
The time the restore was started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
The time the restore was started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
The time the restore finished, unset for ongoing restores.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
The time the restore finished, unset for ongoing restores.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOperationState
The operation state of the restore.
| Returns | |
|---|---|
| Type | Description |
int |
|
setOperationState
The operation state of the restore.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabase
The name of the database being restored to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
The name of the database being restored to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackup
The name of the backup restoring from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBackup
The name of the backup restoring from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProgressPercentage
How far along the restore is as an estimated percentage of remaining time.
| Returns | |
|---|---|
| Type | Description |
Progress|null |
|
hasProgressPercentage
clearProgressPercentage
setProgressPercentage
How far along the restore is as an estimated percentage of remaining time.
| Parameter | |
|---|---|
| Name | Description |
var |
Progress
|
| Returns | |
|---|---|
| Type | Description |
$this |
|