Class MigrationProgressEvent (2.17.6)

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
TypeDescription
int

REDIRECT_WRITES_STEP_DETAILS_FIELD_NUMBER

public static final int REDIRECT_WRITES_STEP_DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

STEP_FIELD_NUMBER

public static final int STEP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MigrationProgressEvent getDefaultInstance()
Returns
TypeDescription
MigrationProgressEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static MigrationProgressEvent.Builder newBuilder()
Returns
TypeDescription
MigrationProgressEvent.Builder

newBuilder(MigrationProgressEvent prototype)

public static MigrationProgressEvent.Builder newBuilder(MigrationProgressEvent prototype)
Parameter
NameDescription
prototypeMigrationProgressEvent
Returns
TypeDescription
MigrationProgressEvent.Builder

parseDelimitedFrom(InputStream input)

public static MigrationProgressEvent parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MigrationProgressEvent parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MigrationProgressEvent parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MigrationProgressEvent parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MigrationProgressEvent parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MigrationProgressEvent parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MigrationProgressEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MigrationProgressEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MigrationProgressEvent> parser()
Returns
TypeDescription
Parser<MigrationProgressEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public MigrationProgressEvent getDefaultInstanceForType()
Returns
TypeDescription
MigrationProgressEvent

getParserForType()

public Parser<MigrationProgressEvent> getParserForType()
Returns
TypeDescription
Parser<MigrationProgressEvent>
Overrides

getPrepareStepDetails()

public MigrationProgressEvent.PrepareStepDetails getPrepareStepDetails()

Details for the PREPARE step.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
MigrationProgressEvent.RedirectWritesStepDetailsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
MigrationStep

The step.

getStepDetailsCase()

public MigrationProgressEvent.StepDetailsCase getStepDetailsCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the redirectWritesStepDetails field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MigrationProgressEvent.Builder newBuilderForType()
Returns
TypeDescription
MigrationProgressEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MigrationProgressEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MigrationProgressEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MigrationProgressEvent.Builder toBuilder()
Returns
TypeDescription
MigrationProgressEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException