ResultSubpartitionView (Flink : Runtime 1.15.1 API)

All Known Implementing Classes:

BoundedBlockingSubpartitionDirectTransferReader, NoOpResultSubpartitionView, PipelinedApproximateSubpartitionView, PipelinedSubpartitionView
```
public interface ResultSubpartitionView
```
A view to consume a ResultSubpartition instance.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ResultSubpartitionView.AvailabilityWithBacklog` Availability of the `ResultSubpartitionView` and the backlog in the corresponding `ResultSubpartition`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`acknowledgeAllDataProcessed()`
`ResultSubpartitionView.AvailabilityWithBacklog`	`getAvailabilityAndBacklog(int numCreditsAvailable)`
`Throwable`	`getFailureCause()` `ResultSubpartitionView` can decide whether the failure cause should be reported to consumer as failure (primary failure) or `ProducerFailedException` (secondary failure).
`ResultSubpartition.BufferAndBacklog`	`getNextBuffer()` Returns the next `Buffer` instance of this queue iterator.
`int`	`getNumberOfQueuedBuffers()`
`boolean`	`isReleased()`
`void`	`notifyDataAvailable()`
`void`	`notifyNewBufferSize(int newBufferSize)`
`default void`	`notifyPriorityEvent(int priorityBufferNumber)`
`void`	`releaseAllResources()`
`void`	`resumeConsumption()`
`int`	`unsynchronizedGetNumberOfQueuedBuffers()`

- Method Detail
  - getNextBuffer
```
@Nullable
ResultSubpartition.BufferAndBacklog getNextBuffer()
                                                     throws IOException
```
    Returns the next Buffer instance of this queue iterator.
    If there is currently no instance available, it will return null. This might happen for example when a pipelined queue producer is slower than the consumer or a spilled queue needs to read in more data.
    Important: The consumer has to make sure that each buffer instance will eventually be recycled with Buffer.recycleBuffer() after it has been consumed.
    
    Throws:
    
    IOException
  - notifyDataAvailable
```
void notifyDataAvailable()
```
  - notifyPriorityEvent
```
default void notifyPriorityEvent(int priorityBufferNumber)
```
  - releaseAllResources
```
void releaseAllResources()
                  throws IOException
```
    Throws:
    
    IOException
  - isReleased
```
boolean isReleased()
```
  - resumeConsumption
```
void resumeConsumption()
```
  - acknowledgeAllDataProcessed
```
void acknowledgeAllDataProcessed()
```
  - getFailureCause
```
Throwable getFailureCause()
```
    ResultSubpartitionView can decide whether the failure cause should be reported to consumer as failure (primary failure) or ProducerFailedException (secondary failure). Secondary failure can be reported only if producer (upstream task) is guaranteed to failover.
    BEWARE: Incorrectly reporting failure cause as primary failure, can hide the root cause of the failure from the user.
  - getAvailabilityAndBacklog
```
ResultSubpartitionView.AvailabilityWithBacklog getAvailabilityAndBacklog(int numCreditsAvailable)
```
  - unsynchronizedGetNumberOfQueuedBuffers
```
int unsynchronizedGetNumberOfQueuedBuffers()
```
  - getNumberOfQueuedBuffers
```
int getNumberOfQueuedBuffers()
```
  - notifyNewBufferSize
```
void notifyNewBufferSize(int newBufferSize)
```

Interface ResultSubpartitionView

Nested Class Summary

Method Summary

Method Detail

getNextBuffer

notifyDataAvailable

notifyPriorityEvent

releaseAllResources

isReleased

resumeConsumption

acknowledgeAllDataProcessed

getFailureCause

getAvailabilityAndBacklog

unsynchronizedGetNumberOfQueuedBuffers

getNumberOfQueuedBuffers

notifyNewBufferSize