org.apache.hudi.avro.model

Class HoodieCleanerPlan

java.lang.Object

org.apache.avro.specific.SpecificRecordBase

org.apache.hudi.avro.model.HoodieCleanerPlan

All Implemented Interfaces:

Externalizable, Serializable, Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord

public class HoodieCleanerPlan
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoodieCleanerPlan.Builder RecordBuilder for HoodieCleanerPlan instances.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.avro.Schema	SCHEMA$

Constructor Summary

Constructors

Constructor and Description
HoodieCleanerPlan() Default constructor.
HoodieCleanerPlan(HoodieActionInstant earliestInstantToRetain, String lastCompletedCommitTimestamp, String policy, Map<String,List<String>> filesToBeDeletedPerPartition, Integer version, Map<String,List<HoodieCleanFileInfo>> filePathsToBeDeletedPerPartition, List<String> partitionsToBeDeleted) All-args constructor.

Method Summary

Modifier and Type	Method and Description
static org.apache.avro.message.BinaryMessageDecoder<HoodieCleanerPlan>	createDecoder(org.apache.avro.message.SchemaStore resolver) Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
void	customDecode(org.apache.avro.io.ResolvingDecoder in)
void	customEncode(org.apache.avro.io.Encoder out)
static HoodieCleanerPlan	fromByteBuffer(ByteBuffer b) Deserializes a HoodieCleanerPlan from a ByteBuffer.
Object	get(int field$)
static org.apache.avro.Schema	getClassSchema()
static org.apache.avro.message.BinaryMessageDecoder<HoodieCleanerPlan>	getDecoder() Return the BinaryMessageDecoder instance used by this class.
HoodieActionInstant	getEarliestInstantToRetain() Gets the value of the 'earliestInstantToRetain' field.
static org.apache.avro.message.BinaryMessageEncoder<HoodieCleanerPlan>	getEncoder() Return the BinaryMessageEncoder instance used by this class.
Map<String,List<HoodieCleanFileInfo>>	getFilePathsToBeDeletedPerPartition() Gets the value of the 'filePathsToBeDeletedPerPartition' field.
Map<String,List<String>>	getFilesToBeDeletedPerPartition() Gets the value of the 'filesToBeDeletedPerPartition' field.
String	getLastCompletedCommitTimestamp() Gets the value of the 'lastCompletedCommitTimestamp' field.
List<String>	getPartitionsToBeDeleted() Gets the value of the 'partitionsToBeDeleted' field.
String	getPolicy() Gets the value of the 'policy' field.
org.apache.avro.Schema	getSchema()
org.apache.avro.specific.SpecificData	getSpecificData()
Integer	getVersion() Gets the value of the 'version' field.
protected boolean	hasCustomCoders()
static HoodieCleanerPlan.Builder	newBuilder() Creates a new HoodieCleanerPlan RecordBuilder.
static HoodieCleanerPlan.Builder	newBuilder(HoodieCleanerPlan.Builder other) Creates a new HoodieCleanerPlan RecordBuilder by copying an existing Builder.
static HoodieCleanerPlan.Builder	newBuilder(HoodieCleanerPlan other) Creates a new HoodieCleanerPlan RecordBuilder by copying an existing HoodieCleanerPlan instance.
void	put(int field$, Object value$)
void	readExternal(ObjectInput in)
void	setEarliestInstantToRetain(HoodieActionInstant value) Sets the value of the 'earliestInstantToRetain' field.
void	setFilePathsToBeDeletedPerPartition(Map<String,List<HoodieCleanFileInfo>> value) Sets the value of the 'filePathsToBeDeletedPerPartition' field.
void	setFilesToBeDeletedPerPartition(Map<String,List<String>> value) Sets the value of the 'filesToBeDeletedPerPartition' field.
void	setLastCompletedCommitTimestamp(String value) Sets the value of the 'lastCompletedCommitTimestamp' field.
void	setPartitionsToBeDeleted(List<String> value) Sets the value of the 'partitionsToBeDeleted' field.
void	setPolicy(String value) Sets the value of the 'policy' field.
void	setVersion(Integer value) Sets the value of the 'version' field.
ByteBuffer	toByteBuffer() Serializes this HoodieCleanerPlan to a ByteBuffer.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.apache.avro.specific.SpecificRecordBase

compareTo, equals, get, getConversion, getConversion, hashCode, put, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.avro.generic.GenericRecord

hasField

Field Detail

SCHEMA$

public static final org.apache.avro.Schema SCHEMA$

Constructor Detail

HoodieCleanerPlan

public HoodieCleanerPlan()

Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should use newBuilder().

HoodieCleanerPlan

public HoodieCleanerPlan(HoodieActionInstant earliestInstantToRetain,
                         String lastCompletedCommitTimestamp,
                         String policy,
                         Map<String,List<String>> filesToBeDeletedPerPartition,
                         Integer version,
                         Map<String,List<HoodieCleanFileInfo>> filePathsToBeDeletedPerPartition,
                         List<String> partitionsToBeDeleted)

All-args constructor.

Parameters:

earliestInstantToRetain - The new value for earliestInstantToRetain

lastCompletedCommitTimestamp - The new value for lastCompletedCommitTimestamp

policy - The new value for policy

filesToBeDeletedPerPartition - The new value for filesToBeDeletedPerPartition

version - The new value for version

filePathsToBeDeletedPerPartition - This field replaces the field filesToBeDeletedPerPartition

partitionsToBeDeleted - partitions to be deleted

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

getEncoder

public static org.apache.avro.message.BinaryMessageEncoder<HoodieCleanerPlan> getEncoder()

Return the BinaryMessageEncoder instance used by this class.

Returns:

the message encoder used by this class

getDecoder

public static org.apache.avro.message.BinaryMessageDecoder<HoodieCleanerPlan> getDecoder()

Return the BinaryMessageDecoder instance used by this class.

Returns:

the message decoder used by this class

createDecoder

public static org.apache.avro.message.BinaryMessageDecoder<HoodieCleanerPlan> createDecoder(org.apache.avro.message.SchemaStore resolver)

Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.

Parameters:

resolver - a SchemaStore used to find schemas by fingerprint

Returns:

a BinaryMessageDecoder instance for this class backed by the given SchemaStore

toByteBuffer

public ByteBuffer toByteBuffer()
                        throws IOException

Serializes this HoodieCleanerPlan to a ByteBuffer.

Returns:

a buffer holding the serialized data for this instance

Throws:

IOException - if this instance could not be serialized

fromByteBuffer

public static HoodieCleanerPlan fromByteBuffer(ByteBuffer b)
                                        throws IOException

Deserializes a HoodieCleanerPlan from a ByteBuffer.

Parameters:

b - a byte buffer holding serialized data for an instance of this class

Returns:

a HoodieCleanerPlan instance decoded from the given buffer

Throws:

IOException - if the given bytes could not be deserialized into an instance of this class

getSpecificData

public org.apache.avro.specific.SpecificData getSpecificData()

Overrides:

getSpecificData in class org.apache.avro.specific.SpecificRecordBase

getSchema

public org.apache.avro.Schema getSchema()

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Specified by:

getSchema in class org.apache.avro.specific.SpecificRecordBase

get

public Object get(int field$)

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Specified by:

get in class org.apache.avro.specific.SpecificRecordBase

put

public void put(int field$,
                Object value$)

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Specified by:

put in class org.apache.avro.specific.SpecificRecordBase

getEarliestInstantToRetain

public HoodieActionInstant getEarliestInstantToRetain()

Gets the value of the 'earliestInstantToRetain' field.

Returns:

The value of the 'earliestInstantToRetain' field.

setEarliestInstantToRetain

public void setEarliestInstantToRetain(HoodieActionInstant value)

Sets the value of the 'earliestInstantToRetain' field.

Parameters:

value - the value to set.

getLastCompletedCommitTimestamp

public String getLastCompletedCommitTimestamp()

Gets the value of the 'lastCompletedCommitTimestamp' field.

Returns:

The value of the 'lastCompletedCommitTimestamp' field.

setLastCompletedCommitTimestamp

public void setLastCompletedCommitTimestamp(String value)

Sets the value of the 'lastCompletedCommitTimestamp' field.

Parameters:

value - the value to set.

getPolicy

public String getPolicy()

Gets the value of the 'policy' field.

Returns:

The value of the 'policy' field.

setPolicy

public void setPolicy(String value)

Sets the value of the 'policy' field.

Parameters:

value - the value to set.

getFilesToBeDeletedPerPartition

public Map<String,List<String>> getFilesToBeDeletedPerPartition()

Gets the value of the 'filesToBeDeletedPerPartition' field.

Returns:

The value of the 'filesToBeDeletedPerPartition' field.

setFilesToBeDeletedPerPartition

public void setFilesToBeDeletedPerPartition(Map<String,List<String>> value)

Sets the value of the 'filesToBeDeletedPerPartition' field.

Parameters:

value - the value to set.

getVersion

public Integer getVersion()

Gets the value of the 'version' field.

Returns:

The value of the 'version' field.

setVersion

public void setVersion(Integer value)

Sets the value of the 'version' field.

Parameters:

value - the value to set.

getFilePathsToBeDeletedPerPartition

public Map<String,List<HoodieCleanFileInfo>> getFilePathsToBeDeletedPerPartition()

Gets the value of the 'filePathsToBeDeletedPerPartition' field.

Returns:

This field replaces the field filesToBeDeletedPerPartition

setFilePathsToBeDeletedPerPartition

public void setFilePathsToBeDeletedPerPartition(Map<String,List<HoodieCleanFileInfo>> value)

Sets the value of the 'filePathsToBeDeletedPerPartition' field. This field replaces the field filesToBeDeletedPerPartition

Parameters:

value - the value to set.

getPartitionsToBeDeleted

public List<String> getPartitionsToBeDeleted()

Gets the value of the 'partitionsToBeDeleted' field.

Returns:

partitions to be deleted

setPartitionsToBeDeleted

public void setPartitionsToBeDeleted(List<String> value)

Sets the value of the 'partitionsToBeDeleted' field. partitions to be deleted

Parameters:

value - the value to set.

newBuilder

public static HoodieCleanerPlan.Builder newBuilder()

Creates a new HoodieCleanerPlan RecordBuilder.

Returns:

A new HoodieCleanerPlan RecordBuilder

newBuilder

public static HoodieCleanerPlan.Builder newBuilder(HoodieCleanerPlan.Builder other)

Creates a new HoodieCleanerPlan RecordBuilder by copying an existing Builder.

Parameters:

other - The existing builder to copy.

Returns:

A new HoodieCleanerPlan RecordBuilder

newBuilder

public static HoodieCleanerPlan.Builder newBuilder(HoodieCleanerPlan other)

Creates a new HoodieCleanerPlan RecordBuilder by copying an existing HoodieCleanerPlan instance.

Parameters:

other - The existing instance to copy.

Returns:

A new HoodieCleanerPlan RecordBuilder

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException

hasCustomCoders

protected boolean hasCustomCoders()

Overrides:

hasCustomCoders in class org.apache.avro.specific.SpecificRecordBase

customEncode

public void customEncode(org.apache.avro.io.Encoder out)
                  throws IOException

Overrides:

customEncode in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException

customDecode

public void customDecode(org.apache.avro.io.ResolvingDecoder in)
                  throws IOException

Overrides:

customDecode in class org.apache.avro.specific.SpecificRecordBase

Throws:

IOException