Class MigrationProgressEvent (2.23.0)

public final class MigrationProgressEvent extends GeneratedMessageV3 implements MigrationProgressEventOrBuilder

An event signifying the start of a new step in a migration from Cloud Datastore to Cloud Firestore in Datastore mode.

Protobuf type google.datastore.admin.v1.MigrationProgressEvent

Static Fields

PREPARE_STEP_DETAILS_FIELD_NUMBER

public static final int PREPARE_STEP_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

REDIRECT_WRITES_STEP_DETAILS_FIELD_NUMBER

public static final int REDIRECT_WRITES_STEP_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

STEP_FIELD_NUMBER

public static final int STEP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MigrationProgressEvent getDefaultInstance()
Returns
Type Description
MigrationProgressEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MigrationProgressEvent.Builder newBuilder()
Returns
Type Description
MigrationProgressEvent.Builder

newBuilder(MigrationProgressEvent prototype)

public static MigrationProgressEvent.Builder newBuilder(MigrationProgressEvent prototype)
Parameter
Name Description
prototype MigrationProgressEvent
Returns
Type Description
MigrationProgressEvent.Builder

parseDelimitedFrom(InputStream input)

public static MigrationProgressEvent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MigrationProgressEvent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MigrationProgressEvent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MigrationProgressEvent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MigrationProgressEvent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MigrationProgressEvent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationProgressEvent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MigrationProgressEvent> parser()
Returns
Type Description
Parser<MigrationProgressEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public MigrationProgressEvent getDefaultInstanceForType()
Returns
Type Description
MigrationProgressEvent

getParserForType()

public Parser<MigrationProgressEvent> getParserForType()
Returns
Type Description
Parser<MigrationProgressEvent>
Overrides

getPrepareStepDetails()

public MigrationProgressEvent.PrepareStepDetails getPrepareStepDetails()

Details for the PREPARE step.

.google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails prepare_step_details = 2;

Returns
Type Description
MigrationProgressEvent.PrepareStepDetails

The prepareStepDetails.

getPrepareStepDetailsOrBuilder()

public MigrationProgressEvent.PrepareStepDetailsOrBuilder getPrepareStepDetailsOrBuilder()

Details for the PREPARE step.

.google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails prepare_step_details = 2;

Returns
Type Description
MigrationProgressEvent.PrepareStepDetailsOrBuilder

getRedirectWritesStepDetails()

public MigrationProgressEvent.RedirectWritesStepDetails getRedirectWritesStepDetails()

Details for the REDIRECT_WRITES step.

.google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails redirect_writes_step_details = 3;

Returns
Type Description
MigrationProgressEvent.RedirectWritesStepDetails

The redirectWritesStepDetails.

getRedirectWritesStepDetailsOrBuilder()

public MigrationProgressEvent.RedirectWritesStepDetailsOrBuilder getRedirectWritesStepDetailsOrBuilder()

Details for the REDIRECT_WRITES step.

.google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails redirect_writes_step_details = 3;

Returns
Type Description
MigrationProgressEvent.RedirectWritesStepDetailsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStep()

public MigrationStep 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.

.google.datastore.admin.v1.MigrationStep step = 1;

Returns
Type Description
MigrationStep

The step.

getStepDetailsCase()

public MigrationProgressEvent.StepDetailsCase getStepDetailsCase()
Returns
Type Description
MigrationProgressEvent.StepDetailsCase

getStepValue()

public int getStepValue()

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.

.google.datastore.admin.v1.MigrationStep step = 1;

Returns
Type Description
int

The enum numeric value on the wire for step.

hasPrepareStepDetails()

public boolean hasPrepareStepDetails()

Details for the PREPARE step.

.google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails prepare_step_details = 2;

Returns
Type Description
boolean

Whether the prepareStepDetails field is set.

hasRedirectWritesStepDetails()

public boolean hasRedirectWritesStepDetails()

Details for the REDIRECT_WRITES step.

.google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails redirect_writes_step_details = 3;

Returns
Type Description
boolean

Whether the redirectWritesStepDetails field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MigrationProgressEvent.Builder newBuilderForType()
Returns
Type Description
MigrationProgressEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MigrationProgressEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MigrationProgressEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MigrationProgressEvent.Builder toBuilder()
Returns
Type Description
MigrationProgressEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException