org.apache.tez.dag.api

Class UserPayload

java.lang.Object

org.apache.tez.dag.api.UserPayload

@InterfaceAudience.Public
public final class UserPayload
extends Object

Wrapper class to hold user payloads Provides a version to help in evolving the payloads

Method Summary

Modifier and Type	Method and Description
static UserPayload	create(ByteBuffer payload) Create a UserPayload instance which encapsulates a ByteBuffer.
static UserPayload	create(ByteBuffer payload, int version) Create an explicitly versioned UserPayload instance which encapsulates a ByteBuffer.
byte[]	deepCopyAsArray()
ByteBuffer	getPayload() Return the payload as a read-only ByteBuffer.
ByteBuffer	getRawPayload() Return the payload as a ByteBuffer.
int	getVersion()
boolean	hasPayload()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static UserPayload create(@Nullable
                                 ByteBuffer payload)

Create a UserPayload instance which encapsulates a ByteBuffer. The version number used will be 0

Parameters:

payload - the ByteBuffer payload

Returns:

an instance of UserPayload

create

public static UserPayload create(@Nullable
                                 ByteBuffer payload,
                                 int version)

Create an explicitly versioned UserPayload instance which encapsulates a ByteBuffer.

Parameters:

payload - the ByteBuffer payload

Returns:

an instance of UserPayload

getRawPayload

@Nullable
public ByteBuffer getRawPayload()

Return the payload as a ByteBuffer.

Returns:

ByteBuffer.

getPayload

@Nullable
public ByteBuffer getPayload()

Return the payload as a read-only ByteBuffer.

Returns:

read-only ByteBuffer.

getVersion

public int getVersion()

hasPayload

public boolean hasPayload()

deepCopyAsArray

@InterfaceStability.Unstable
public byte[] deepCopyAsArray()