Package google.registry.rde
Class PendingDeposit
java.lang.Object
google.registry.rde.PendingDeposit
- All Implemented Interfaces:
Serializable
Container representing a single RDE or BRDA XML escrow deposit that needs to be created.
There are some @Nullable
fields here because Optionals aren't Serializable.
Note that this class is serialized in two ways: by Beam pipelines using custom serialization
mechanism and the Coder
API, and by Java serialization when passed as command-line
arguments (see RdePipeline#decodePendingDeposits
). The latter requires safe
deserialization because the data crosses credential boundaries (See
SafeObjectInputStream
).
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A deterministic coder forPendingDeposit
used during a GroupBy transform. -
Method Summary
Modifier and TypeMethodDescriptionstatic PendingDeposit
create
(String tld, org.joda.time.DateTime watermark, RdeMode mode, Cursor.CursorType cursor, org.joda.time.Duration interval) static PendingDeposit
createInManualOperation
(String tld, org.joda.time.DateTime watermark, RdeMode mode, String directoryWithTrailingSlash, Integer revision) abstract Cursor.CursorType
cursor()
The cursor type to update (not used in manual operation).abstract String
Subdirectory of bucket/manual in which files should be placed, including a trailing slash (used only in manual operation).abstract org.joda.time.Duration
interval()
Amount of time to increment the cursor (not used in manual operation).abstract boolean
manual()
True if deposits should be generated via manual operation, which does not update the cursor, and saves the generated deposits in a special manual subdirectory tree.abstract RdeMode
mode()
Which type of deposit to generate: full (RDE) or thin (BRDA).abstract Integer
revision()
Revision number for generated files; if absent, use the next available in the sequence (used only in manual operation).abstract String
tld()
TLD for which a deposit should be generated.abstract org.joda.time.DateTime
Watermark date for which a deposit should be generated.
-
Method Details
-
manual
public abstract boolean manual()True if deposits should be generated via manual operation, which does not update the cursor, and saves the generated deposits in a special manual subdirectory tree. -
tld
TLD for which a deposit should be generated. -
watermark
public abstract org.joda.time.DateTime watermark()Watermark date for which a deposit should be generated. -
mode
Which type of deposit to generate: full (RDE) or thin (BRDA). -
cursor
The cursor type to update (not used in manual operation). -
interval
@Nullable public abstract org.joda.time.Duration interval()Amount of time to increment the cursor (not used in manual operation). -
directoryWithTrailingSlash
Subdirectory of bucket/manual in which files should be placed, including a trailing slash (used only in manual operation). -
revision
Revision number for generated files; if absent, use the next available in the sequence (used only in manual operation). -
create
public static PendingDeposit create(String tld, org.joda.time.DateTime watermark, RdeMode mode, Cursor.CursorType cursor, org.joda.time.Duration interval) -
createInManualOperation
public static PendingDeposit createInManualOperation(String tld, org.joda.time.DateTime watermark, RdeMode mode, String directoryWithTrailingSlash, @Nullable Integer revision)
-