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

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
NameDescription
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 Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails

Details for the PREPARE step.

↳ redirect_writes_step_details Google\Cloud\Datastore\Admin\V1\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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPrepareStepDetails

Details for the PREPARE step.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails|null

hasPrepareStepDetails

setPrepareStepDetails

Details for the PREPARE step.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\PrepareStepDetails
Returns
TypeDescription
$this

getRedirectWritesStepDetails

Details for the REDIRECT_WRITES step.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\RedirectWritesStepDetails|null

hasRedirectWritesStepDetails

setRedirectWritesStepDetails

Details for the REDIRECT_WRITES step.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\MigrationProgressEvent\RedirectWritesStepDetails
Returns
TypeDescription
$this

getStepDetails

Returns
TypeDescription
string