org.apache.flink.streaming.runtime.operators.sink.committables

Class CommitRequestImpl<CommT>

java.lang.Object

org.apache.flink.streaming.runtime.operators.sink.committables.CommitRequestImpl<CommT>

Type Parameters:

CommT - type of committable

All Implemented Interfaces:

Committer.CommitRequest<CommT>

@Internal
public class CommitRequestImpl<CommT>
extends Object
implements Committer.CommitRequest<CommT>

Internal implementation to commit a specific committable and handle the response.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommitRequestImpl(CommT committable, int numRetries, CommitRequestState state, SinkCommitterMetricGroup metricGroup)
protected	CommitRequestImpl(CommT committable, SinkCommitterMetricGroup metricGroup)

Method Summary

Modifier and Type	Method and Description
CommT	getCommittable() Returns the committable.
int	getNumberOfRetries() Returns how many times this particular committable has been retried.
void	retryLater() The commit failed for a retriable reason.
void	signalAlreadyCommitted() Signals that a committable is skipped as it was committed already in a previous run.
void	signalFailedWithKnownReason(Throwable t) The commit failed for known reason and should not be retried.
void	signalFailedWithUnknownReason(Throwable t) The commit failed for unknown reason and should not be retried.
void	updateAndRetryLater(CommT committable) Updates the underlying committable and retries later (see Committer.CommitRequest.retryLater() for a description).

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitRequestImpl

protected CommitRequestImpl(CommT committable,
                            SinkCommitterMetricGroup metricGroup)

CommitRequestImpl

protected CommitRequestImpl(CommT committable,
                            int numRetries,
                            CommitRequestState state,
                            SinkCommitterMetricGroup metricGroup)

Method Detail

getCommittable

public CommT getCommittable()

Description copied from interface: Committer.CommitRequest

Returns the committable.

Specified by:

getCommittable in interface Committer.CommitRequest<CommT>

getNumberOfRetries

public int getNumberOfRetries()

Description copied from interface: Committer.CommitRequest

Returns how many times this particular committable has been retried. Starts at 0 for the first attempt.

Specified by:

getNumberOfRetries in interface Committer.CommitRequest<CommT>

signalFailedWithKnownReason

public void signalFailedWithKnownReason(Throwable t)

Description copied from interface: Committer.CommitRequest

The commit failed for known reason and should not be retried.

Currently calling this method only logs the error, discards the comittable and continues. In the future the behaviour might be configurable.

Specified by:

signalFailedWithKnownReason in interface Committer.CommitRequest<CommT>

signalFailedWithUnknownReason

public void signalFailedWithUnknownReason(Throwable t)

Description copied from interface: Committer.CommitRequest

The commit failed for unknown reason and should not be retried.

Currently calling this method fails the job. In the future the behaviour might be configurable.

Specified by:

signalFailedWithUnknownReason in interface Committer.CommitRequest<CommT>

retryLater

public void retryLater()

Description copied from interface: Committer.CommitRequest

The commit failed for a retriable reason. If the sink supports a retry maximum, this may permanently fail after reaching that maximum. Else the committable will be retried as long as this method is invoked after each attempt.

Specified by:

retryLater in interface Committer.CommitRequest<CommT>

updateAndRetryLater

public void updateAndRetryLater(CommT committable)

Description copied from interface: Committer.CommitRequest

Updates the underlying committable and retries later (see Committer.CommitRequest.retryLater() for a description). This method can be used if a committable partially succeeded.

Specified by:

updateAndRetryLater in interface Committer.CommitRequest<CommT>

signalAlreadyCommitted

public void signalAlreadyCommitted()

Description copied from interface: Committer.CommitRequest

Signals that a committable is skipped as it was committed already in a previous run. Using this method is optional but eases bookkeeping and debugging. It also serves as a code documentation for the branches dealing with recovery.

Specified by:

signalAlreadyCommitted in interface Committer.CommitRequest<CommT>