org.apache.hudi.client

Class WriteStatus

java.lang.Object

org.apache.hudi.client.WriteStatus

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BootstrapWriteStatus, FailOnFirstErrorWriteStatus

@PublicAPIClass(maturity=STABLE)
public class WriteStatus
extends Object
implements Serializable

Status of a write operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WriteStatus()
WriteStatus(Boolean trackSuccessRecords, Double failureFraction)

Method Summary

Modifier and Type	Method and Description
HashMap<HoodieKey,Throwable>	getErrors()
List<Pair<HoodieRecordDelegate,Throwable>>	getFailedRecords()
String	getFileId()
Throwable	getGlobalError()
String	getPartitionPath()
HoodieWriteStat	getStat()
long	getTotalErrorRecords()
long	getTotalRecords()
List<HoodieRecordDelegate>	getWrittenRecordDelegates()
boolean	hasErrors()
boolean	hasGlobalError()
boolean	isErrored(HoodieKey key)
boolean	isTrackingSuccessfulWrites()
void	markFailure(HoodieRecord record, Throwable t, Option<Map<String,String>> optionalRecordMetadata) Mark write as failed, optionally using given parameters for the purpose of calculating some aggregate metrics.
void	markFailure(String recordKey, String partitionPath, Throwable t) Used by native write handles like HoodieRowCreateHandle and HoodieRowDataCreateHandle.
void	markSuccess(HoodieRecordDelegate recordDelegate, Option<Map<String,String>> optionalRecordMetadata) Used by native write handles like HoodieRowCreateHandle and HoodieRowDataCreateHandle.
void	markSuccess(HoodieRecord record, Option<Map<String,String>> optionalRecordMetadata) Mark write as success, optionally using given parameters for the purpose of calculating some aggregate metrics.
void	setFileId(String fileId)
void	setGlobalError(Throwable t)
void	setPartitionPath(String partitionPath)
void	setStat(HoodieWriteStat stat)
void	setTotalErrorRecords(long totalErrorRecords)
void	setTotalRecords(long totalRecords)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WriteStatus

public WriteStatus(Boolean trackSuccessRecords,
                   Double failureFraction)

WriteStatus

public WriteStatus()

Method Detail

markSuccess

public void markSuccess(HoodieRecord record,
                        Option<Map<String,String>> optionalRecordMetadata)

Mark write as success, optionally using given parameters for the purpose of calculating some aggregate metrics. This method is not meant to cache passed arguments, since WriteStatus objects are collected in Spark Driver.

Parameters:

record - deflated HoodieRecord containing information that uniquely identifies it.

optionalRecordMetadata - optional metadata related to data contained in HoodieRecord before deflation.

markSuccess

@PublicAPIMethod(maturity=EVOLVING)
public void markSuccess(HoodieRecordDelegate recordDelegate,
                                                            Option<Map<String,String>> optionalRecordMetadata)

Used by native write handles like HoodieRowCreateHandle and HoodieRowDataCreateHandle.

See Also:

markSuccess(HoodieRecord, Option)

markFailure

public void markFailure(HoodieRecord record,
                        Throwable t,
                        Option<Map<String,String>> optionalRecordMetadata)

Mark write as failed, optionally using given parameters for the purpose of calculating some aggregate metrics. This method is not meant to cache passed arguments, since WriteStatus objects are collected in Spark Driver.

Parameters:

record - deflated HoodieRecord containing information that uniquely identifies it.

optionalRecordMetadata - optional metadata related to data contained in HoodieRecord before deflation.

markFailure

@PublicAPIMethod(maturity=EVOLVING)
public void markFailure(String recordKey,
                                                            String partitionPath,
                                                            Throwable t)

Used by native write handles like HoodieRowCreateHandle and HoodieRowDataCreateHandle.

See Also:

markFailure(HoodieRecord, Throwable, Option)

getFileId

public String getFileId()

setFileId

public void setFileId(String fileId)

hasErrors

public boolean hasErrors()

isErrored

public boolean isErrored(HoodieKey key)

getErrors

public HashMap<HoodieKey,Throwable> getErrors()

hasGlobalError

public boolean hasGlobalError()

getGlobalError

public Throwable getGlobalError()

setGlobalError

public void setGlobalError(Throwable t)

getWrittenRecordDelegates

public List<HoodieRecordDelegate> getWrittenRecordDelegates()

getFailedRecords

public List<Pair<HoodieRecordDelegate,Throwable>> getFailedRecords()

getStat

public HoodieWriteStat getStat()

setStat

public void setStat(HoodieWriteStat stat)

getPartitionPath

public String getPartitionPath()

setPartitionPath

public void setPartitionPath(String partitionPath)

getTotalRecords

public long getTotalRecords()

setTotalRecords

public void setTotalRecords(long totalRecords)

getTotalErrorRecords

public long getTotalErrorRecords()

setTotalErrorRecords

public void setTotalErrorRecords(long totalErrorRecords)

isTrackingSuccessfulWrites

public boolean isTrackingSuccessfulWrites()

toString

public String toString()

Overrides:

toString in class Object