Reference documentation and code samples for the Google Cloud Datastore Admin V1 Client class MigrationProgressEvent.
An event signifying the start of a new step in a migration from Cloud Datastore to Cloud Firestore in Datastore mode.
Generated from protobuf message google.datastore.admin.v1.MigrationProgressEvent
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ step |
int
The step that is starting. An event with step set to |
↳ prepare_step_details |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails
Details for the |
↳ redirect_writes_step_details |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\RedirectWritesStepDetails
Details for the |
getStep
The step that is starting.
An event with step set to START indicates that the migration
has been reverted back to the initial pre-migration state.
| Returns | |
|---|---|
| Type | Description |
int | |
setStep
The step that is starting.
An event with step set to START indicates that the migration
has been reverted back to the initial pre-migration state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrepareStepDetails
Details for the PREPARE step.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails|null | |
hasPrepareStepDetails
setPrepareStepDetails
Details for the PREPARE step.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRedirectWritesStepDetails
Details for the REDIRECT_WRITES step.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\RedirectWritesStepDetails|null | |
hasRedirectWritesStepDetails
setRedirectWritesStepDetails
Details for the REDIRECT_WRITES step.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\RedirectWritesStepDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStepDetails
| Returns | |
|---|---|
| Type | Description |
string | |