org.apache.hudi.avro.model

Class HoodieRecordIndexInfo

java.lang.Object

org.apache.avro.specific.SpecificRecordBase

org.apache.hudi.avro.model.HoodieRecordIndexInfo

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 HoodieRecordIndexInfo
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	HoodieRecordIndexInfo.Builder RecordBuilder for HoodieRecordIndexInfo instances.

Field Summary

Fields

Modifier and Type	Field and Description
String	fileId Deprecated.
int	fileIdEncoding Deprecated.
Long	fileIdHighBits Deprecated.
Long	fileIdLowBits Deprecated.
Integer	fileIndex Deprecated.
Long	instantTime Deprecated.
String	partitionName Deprecated.
Long	position Deprecated.
static org.apache.avro.Schema	SCHEMA$

Constructor Summary

Constructors

Constructor and Description
HoodieRecordIndexInfo() Default constructor.
HoodieRecordIndexInfo(String partitionName, Long fileIdHighBits, Long fileIdLowBits, Integer fileIndex, String fileId, Long instantTime, Integer fileIdEncoding, Long position) All-args constructor.

Method Summary

Modifier and Type	Method and Description
static org.apache.avro.message.BinaryMessageDecoder<HoodieRecordIndexInfo>	createDecoder(org.apache.avro.message.SchemaStore resolver) Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
static HoodieRecordIndexInfo	fromByteBuffer(ByteBuffer b) Deserializes a HoodieRecordIndexInfo from a ByteBuffer.
Object	get(int field$)
static org.apache.avro.Schema	getClassSchema()
static org.apache.avro.message.BinaryMessageDecoder<HoodieRecordIndexInfo>	getDecoder() Return the BinaryMessageDecoder instance used by this class.
String	getFileId() Gets the value of the 'fileId' field.
Integer	getFileIdEncoding() Gets the value of the 'fileIdEncoding' field.
Long	getFileIdHighBits() Gets the value of the 'fileIdHighBits' field.
Long	getFileIdLowBits() Gets the value of the 'fileIdLowBits' field.
Integer	getFileIndex() Gets the value of the 'fileIndex' field.
Long	getInstantTime() Gets the value of the 'instantTime' field.
String	getPartitionName() Gets the value of the 'partitionName' field.
Long	getPosition() Gets the value of the 'position' field.
org.apache.avro.Schema	getSchema()
static HoodieRecordIndexInfo.Builder	newBuilder() Creates a new HoodieRecordIndexInfo RecordBuilder.
static HoodieRecordIndexInfo.Builder	newBuilder(HoodieRecordIndexInfo.Builder other) Creates a new HoodieRecordIndexInfo RecordBuilder by copying an existing Builder.
static HoodieRecordIndexInfo.Builder	newBuilder(HoodieRecordIndexInfo other) Creates a new HoodieRecordIndexInfo RecordBuilder by copying an existing HoodieRecordIndexInfo instance.
void	put(int field$, Object value$)
void	readExternal(ObjectInput in)
void	setFileId(String value) Sets the value of the 'fileId' field.
void	setFileIdEncoding(Integer value) Sets the value of the 'fileIdEncoding' field.
void	setFileIdHighBits(Long value) Sets the value of the 'fileIdHighBits' field.
void	setFileIdLowBits(Long value) Sets the value of the 'fileIdLowBits' field.
void	setFileIndex(Integer value) Sets the value of the 'fileIndex' field.
void	setInstantTime(Long value) Sets the value of the 'instantTime' field.
void	setPartitionName(String value) Sets the value of the 'partitionName' field.
void	setPosition(Long value) Sets the value of the 'position' field.
ByteBuffer	toByteBuffer() Serializes this HoodieRecordIndexInfo to a ByteBuffer.
void	writeExternal(ObjectOutput out)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA$

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

partitionName

@Deprecated
public String partitionName

Deprecated.

Refers to the partition name the record belongs to

fileIdHighBits

@Deprecated
public Long fileIdHighBits

Deprecated.

Refers to high 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileIdLowBits

@Deprecated
public Long fileIdLowBits

Deprecated.

Refers to low 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileIndex

@Deprecated
public Integer fileIndex

Deprecated.

Index representing file index which is used to re-construct UUID based fileID. Applicable when the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileId

@Deprecated
public String fileId

Deprecated.

Represents fileId of the location where record belongs to. When the encoding is 1, fileID is stored in raw string format.

instantTime

@Deprecated
public Long instantTime

Deprecated.

Epoch time in millisecond representing the commit time at which record was added

fileIdEncoding

@Deprecated
public int fileIdEncoding

Deprecated.

Represents fileId encoding. Possible values are 0 and 1. O represents UUID based fileID, and 1 represents raw string format of the fileId. When the encoding is 0, reader can deduce fileID from fileIdLowBits, fileIdHighBits and fileIndex.

position

@Deprecated
public Long position

Deprecated.

Represents position of record within a file group for easier access. It will be used for index lookup.

Constructor Detail

HoodieRecordIndexInfo

public HoodieRecordIndexInfo()

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().

HoodieRecordIndexInfo

public HoodieRecordIndexInfo(String partitionName,
                             Long fileIdHighBits,
                             Long fileIdLowBits,
                             Integer fileIndex,
                             String fileId,
                             Long instantTime,
                             Integer fileIdEncoding,
                             Long position)

All-args constructor.

Parameters:

partitionName - Refers to the partition name the record belongs to

fileIdHighBits - Refers to high 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileIdLowBits - Refers to low 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileIndex - Index representing file index which is used to re-construct UUID based fileID. Applicable when the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

fileId - Represents fileId of the location where record belongs to. When the encoding is 1, fileID is stored in raw string format.

instantTime - Epoch time in millisecond representing the commit time at which record was added

fileIdEncoding - Represents fileId encoding. Possible values are 0 and 1. O represents UUID based fileID, and 1 represents raw string format of the fileId. When the encoding is 0, reader can deduce fileID from fileIdLowBits, fileIdHighBits and fileIndex.

position - Represents position of record within a file group for easier access. It will be used for index lookup.

Method Detail

getClassSchema

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

getDecoder

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

Return the BinaryMessageDecoder instance used by this class.

createDecoder

public static org.apache.avro.message.BinaryMessageDecoder<HoodieRecordIndexInfo> 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

toByteBuffer

public ByteBuffer toByteBuffer()
                        throws IOException

Serializes this HoodieRecordIndexInfo to a ByteBuffer.

Throws:

IOException

fromByteBuffer

public static HoodieRecordIndexInfo fromByteBuffer(ByteBuffer b)
                                            throws IOException

Deserializes a HoodieRecordIndexInfo from a ByteBuffer.

Throws:

IOException

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

getPartitionName

public String getPartitionName()

Gets the value of the 'partitionName' field.

Returns:

Refers to the partition name the record belongs to

setPartitionName

public void setPartitionName(String value)

Sets the value of the 'partitionName' field. Refers to the partition name the record belongs to

Parameters:

value - the value to set.

getFileIdHighBits

public Long getFileIdHighBits()

Gets the value of the 'fileIdHighBits' field.

Returns:

Refers to high 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

setFileIdHighBits

public void setFileIdHighBits(Long value)

Sets the value of the 'fileIdHighBits' field. Refers to high 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

Parameters:

value - the value to set.

getFileIdLowBits

public Long getFileIdLowBits()

Gets the value of the 'fileIdLowBits' field.

Returns:

Refers to low 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

setFileIdLowBits

public void setFileIdLowBits(Long value)

Sets the value of the 'fileIdLowBits' field. Refers to low 64 bits if the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

Parameters:

value - the value to set.

getFileIndex

public Integer getFileIndex()

Gets the value of the 'fileIndex' field.

Returns:

Index representing file index which is used to re-construct UUID based fileID. Applicable when the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

setFileIndex

public void setFileIndex(Integer value)

Sets the value of the 'fileIndex' field. Index representing file index which is used to re-construct UUID based fileID. Applicable when the fileId is based on UUID format. A UUID based fileId is stored as 3 pieces in RLI (fileIdHighBits, fileIdLowBits and fileIndex). FileID format is {UUID}-{fileIndex}.

Parameters:

value - the value to set.

getFileId

public String getFileId()

Gets the value of the 'fileId' field.

Returns:

Represents fileId of the location where record belongs to. When the encoding is 1, fileID is stored in raw string format.

setFileId

public void setFileId(String value)

Sets the value of the 'fileId' field. Represents fileId of the location where record belongs to. When the encoding is 1, fileID is stored in raw string format.

Parameters:

value - the value to set.

getInstantTime

public Long getInstantTime()

Gets the value of the 'instantTime' field.

Returns:

Epoch time in millisecond representing the commit time at which record was added

setInstantTime

public void setInstantTime(Long value)

Sets the value of the 'instantTime' field. Epoch time in millisecond representing the commit time at which record was added

Parameters:

value - the value to set.

getFileIdEncoding

public Integer getFileIdEncoding()

Gets the value of the 'fileIdEncoding' field.

Returns:

Represents fileId encoding. Possible values are 0 and 1. O represents UUID based fileID, and 1 represents raw string format of the fileId. When the encoding is 0, reader can deduce fileID from fileIdLowBits, fileIdHighBits and fileIndex.

setFileIdEncoding

public void setFileIdEncoding(Integer value)

Sets the value of the 'fileIdEncoding' field. Represents fileId encoding. Possible values are 0 and 1. O represents UUID based fileID, and 1 represents raw string format of the fileId. When the encoding is 0, reader can deduce fileID from fileIdLowBits, fileIdHighBits and fileIndex.

Parameters:

value - the value to set.

getPosition

public Long getPosition()

Gets the value of the 'position' field.

Returns:

Represents position of record within a file group for easier access. It will be used for index lookup.

setPosition

public void setPosition(Long value)

Sets the value of the 'position' field. Represents position of record within a file group for easier access. It will be used for index lookup.

Parameters:

value - the value to set.

newBuilder

public static HoodieRecordIndexInfo.Builder newBuilder()

Creates a new HoodieRecordIndexInfo RecordBuilder.

Returns:

A new HoodieRecordIndexInfo RecordBuilder

newBuilder

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

Creates a new HoodieRecordIndexInfo RecordBuilder by copying an existing Builder.

Parameters:

other - The existing builder to copy.

Returns:

A new HoodieRecordIndexInfo RecordBuilder

newBuilder

public static HoodieRecordIndexInfo.Builder newBuilder(HoodieRecordIndexInfo other)

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

Parameters:

other - The existing instance to copy.

Returns:

A new HoodieRecordIndexInfo 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