org.apache.flink.runtime.deployment

Class GateDeploymentDescriptor

java.lang.Object

org.apache.flink.runtime.deployment.GateDeploymentDescriptor

All Implemented Interfaces:

IOReadableWritable

public final class GateDeploymentDescriptor
extends Object
implements IOReadableWritable

A gate deployment descriptor contains all the information necessary to deploy either an input or an output gate as part of a task on a task manager.

This class is not thread-safe in general.

Constructor Summary

Constructors

Constructor and Description
GateDeploymentDescriptor() Default constructor for serialization/deserialization.
GateDeploymentDescriptor(GateID gateID, ChannelType channelType, List<ChannelDeploymentDescriptor> channels) Constructs a new gate deployment descriptor

Method Summary

Methods

Modifier and Type	Method and Description
ChannelDeploymentDescriptor	getChannelDescriptor(int index)
ChannelType	getChannelType() Returns the channel type of the gate.
GateID	getGateID() Returns the ID of the gate.
int	getNumberOfChannelDescriptors() Returns the number of channel deployment descriptors attached to this gate descriptor.
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

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

Constructor Detail

GateDeploymentDescriptor

public GateDeploymentDescriptor(GateID gateID,
                        ChannelType channelType,
                        List<ChannelDeploymentDescriptor> channels)

Constructs a new gate deployment descriptor

Parameters:

gateID - the ID of the gate

channelType - the channel type of the gate

compressionLevel - the compression level of the gate

channels - the list of channel deployment descriptors attached to this gate

GateDeploymentDescriptor

public GateDeploymentDescriptor()

Default constructor for serialization/deserialization.

Method Detail

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

getGateID

public GateID getGateID()

Returns the ID of the gate.

Returns:

the ID of the gate

getChannelType

public ChannelType getChannelType()

Returns the channel type of the gate.

Returns:

the channel type of the gate

getNumberOfChannelDescriptors

public int getNumberOfChannelDescriptors()

Returns the number of channel deployment descriptors attached to this gate descriptor.

Returns:

the number of channel deployment descriptors

getChannelDescriptor

public ChannelDeploymentDescriptor getChannelDescriptor(int index)