Google Cloud Datastore Admin V1 Client - Class MigrationProgressEvent (1.1.1)

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

Namespace

Google \ Cloud \ Datastore \ Admin \ V1

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 `START` indicates that the migration has been reverted back to the initial pre-migration state.
`↳ prepare_step_details`	`MigrationProgressEvent\PrepareStepDetails` Details for the `PREPARE` step.
`↳ redirect_writes_step_details`	`MigrationProgressEvent\RedirectWritesStepDetails` Details for the `REDIRECT_WRITES` step.

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`	Enum of type MigrationStep.

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` Enum of type MigrationStep.

Returns
Type	Description
`$this`

getPrepareStepDetails

Details for the PREPARE step.

Returns
Type	Description
`MigrationProgressEvent\PrepareStepDetails\|null`

hasPrepareStepDetails

setPrepareStepDetails