UnionResultSubpartitionView (Flink : Runtime 1.20.0 API)

java.lang.Object
- org.apache.flink.runtime.io.network.partition.UnionResultSubpartitionView

所有已实现的接口:

BufferAvailabilityListener, ResultSubpartitionView
```
public class UnionResultSubpartitionView
extends Object
implements ResultSubpartitionView, BufferAvailabilityListener
```
A wrapper to union the output from multiple ResultSubpartitionViews. This class provides the following guarantees to the output buffers.
- Each output buffer corresponds to a buffer in one of the subpartitions.
- Buffers in the same subpartition are output without their order changed.
- If a record is split and placed into multiple adjacent buffers due to the capacity limit of the buffer, these buffers will be output consecutively without the entry of buffers from other subpartitions in between.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.flink.runtime.io.network.partition.ResultSubpartitionView
  ResultSubpartitionView.AvailabilityWithBacklog

构造器概要

构造器
构造器和说明

UnionResultSubpartitionView(BufferAvailabilityListener availabilityListener, int numTotalViews)

构造器
构造器和说明
`UnionResultSubpartitionView(BufferAvailabilityListener availabilityListener, int numTotalViews)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`acknowledgeAllDataProcessed()`
`ResultSubpartitionView.AvailabilityWithBacklog`	`getAvailabilityAndBacklog(boolean isCreditAvailable)` Get the availability and backlog of the view.
`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`	`notifyDataAvailable(ResultSubpartitionView view)` Called whenever there might be new data available.
`void`	`notifyNewBufferSize(int newBufferSize)`
`void`	`notifyPriorityEvent(int priorityBufferNumber)` Called when the first priority event is added to the head of the buffer queue.
`void`	`notifyRequiredSegmentId(int subpartitionId, int segmentId)` In tiered storage shuffle mode, only required segments will be sent to prevent the redundant buffer usage.
`void`	`notifyViewCreated(int subpartitionId, ResultSubpartitionView view)`
`int`	`peekNextBufferSubpartitionId()` Returns the index of the subpartition where the next buffer locates, or -1 if there is no buffer available and the subpartition to be consumed is not determined.
`void`	`releaseAllResources()`
`void`	`resumeConsumption()`
`int`	`unsynchronizedGetNumberOfQueuedBuffers()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UnionResultSubpartitionView
```
public UnionResultSubpartitionView(BufferAvailabilityListener availabilityListener,
                                   int numTotalViews)
```
- 方法详细资料
  - notifyViewCreated
```
public void notifyViewCreated(int subpartitionId,
                              ResultSubpartitionView view)
```
  - peekNextBufferSubpartitionId
```
public int peekNextBufferSubpartitionId()
                                 throws IOException
```
    从接口复制的说明: ResultSubpartitionView
    
    Returns the index of the subpartition where the next buffer locates, or -1 if there is no buffer available and the subpartition to be consumed is not determined.
    
    指定者:
    
    peekNextBufferSubpartitionId 在接口中 ResultSubpartitionView
    
    抛出:
    
    IOException
  - getNextBuffer
```
@Nullable
public ResultSubpartition.BufferAndBacklog getNextBuffer()
                                                            throws IOException
```
    从接口复制的说明: ResultSubpartitionView
    
    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.
    
    指定者:
    
    getNextBuffer 在接口中 ResultSubpartitionView
    
    抛出:
    
    IOException
  - notifyDataAvailable
```
public void notifyDataAvailable()
```
    指定者:
    
    notifyDataAvailable 在接口中 ResultSubpartitionView
  - notifyDataAvailable
```
public void notifyDataAvailable(ResultSubpartitionView view)
```
    从接口复制的说明: BufferAvailabilityListener
    
    Called whenever there might be new data available.
    
    指定者:
    
    notifyDataAvailable 在接口中 BufferAvailabilityListener
    
    参数:
    
    view - the ResultSubpartitionView containing available data.
  - notifyPriorityEvent
```
public void notifyPriorityEvent(int priorityBufferNumber)
```
    从接口复制的说明: BufferAvailabilityListener
    
    Called when the first priority event is added to the head of the buffer queue.
    
    指定者:
    
    notifyPriorityEvent 在接口中 BufferAvailabilityListener
    
    指定者:
    
    notifyPriorityEvent 在接口中 ResultSubpartitionView
    
    参数:
    
    priorityBufferNumber - the sequence number that identifies the priority buffer.
  - releaseAllResources
```
public void releaseAllResources()
                         throws IOException
```
    指定者:
    
    releaseAllResources 在接口中 ResultSubpartitionView
    
    抛出:
    
    IOException
  - isReleased
```
public boolean isReleased()
```
    指定者:
    
    isReleased 在接口中 ResultSubpartitionView
  - resumeConsumption
```
public void resumeConsumption()
```
    指定者:
    
    resumeConsumption 在接口中 ResultSubpartitionView
  - acknowledgeAllDataProcessed
```
public void acknowledgeAllDataProcessed()
```
    指定者:
    
    acknowledgeAllDataProcessed 在接口中 ResultSubpartitionView
  - getFailureCause
```
public Throwable getFailureCause()
```
    从接口复制的说明: ResultSubpartitionView
    
    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.
    
    指定者:
    
    getFailureCause 在接口中 ResultSubpartitionView
  - getAvailabilityAndBacklog
```
public ResultSubpartitionView.AvailabilityWithBacklog getAvailabilityAndBacklog(boolean isCreditAvailable)
```
    从接口复制的说明: ResultSubpartitionView
    
    Get the availability and backlog of the view. The availability represents if the view is ready to get buffer from it. The backlog represents the number of available data buffers.
    
    指定者:
    
    getAvailabilityAndBacklog 在接口中 ResultSubpartitionView
    
    参数:
    
    isCreditAvailable - the availability of credits for this ResultSubpartitionView.
    
    返回:
    
    availability and backlog.
  - notifyRequiredSegmentId
```
public void notifyRequiredSegmentId(int subpartitionId,
                                    int segmentId)
```
    从接口复制的说明: ResultSubpartitionView
    
    In tiered storage shuffle mode, only required segments will be sent to prevent the redundant buffer usage. Downstream will notify the upstream by this method to send required segments.
    
    指定者:
    
    notifyRequiredSegmentId 在接口中 ResultSubpartitionView
    
    参数:
    
    subpartitionId - The id of the corresponding subpartition.
    
    segmentId - The id of required segment.
  - unsynchronizedGetNumberOfQueuedBuffers
```
public int unsynchronizedGetNumberOfQueuedBuffers()
```
    指定者:
    
    unsynchronizedGetNumberOfQueuedBuffers 在接口中 ResultSubpartitionView
  - getNumberOfQueuedBuffers
```
public int getNumberOfQueuedBuffers()
```
    指定者:
    
    getNumberOfQueuedBuffers 在接口中 ResultSubpartitionView
  - notifyNewBufferSize
```
public void notifyNewBufferSize(int newBufferSize)
```
    指定者:
    
    notifyNewBufferSize 在接口中 ResultSubpartitionView

类 UnionResultSubpartitionView

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.runtime.io.network.partition.ResultSubpartitionView

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

UnionResultSubpartitionView

方法详细资料

notifyViewCreated

peekNextBufferSubpartitionId

getNextBuffer

notifyDataAvailable

notifyDataAvailable

notifyPriorityEvent

releaseAllResources

isReleased

resumeConsumption

acknowledgeAllDataProcessed

getFailureCause

getAvailabilityAndBacklog

notifyRequiredSegmentId

unsynchronizedGetNumberOfQueuedBuffers

getNumberOfQueuedBuffers

notifyNewBufferSize