org.apache.slider.server.appmaster.state

Class RoleInstance

java.lang.Object

org.apache.slider.server.appmaster.state.RoleInstance

All Implemented Interfaces:

Cloneable

public final class RoleInstance
extends Object
implements Cloneable

Tracking information about a container

Field Summary

Fields

Modifier and Type	Field and Description
String	appVersion Version of the app
String	command what was the command executed?
org.apache.hadoop.yarn.api.records.Container	container
long	createTime
String	diagnostics Any diagnostics
String[]	environment Any environment details
int	exitCode Exit code: only valid if the state >= STOPPED
String	host
String	hostURL
String	id Container ID
String[]	output What is the tail output from the executed process (or [] if not started or the log cannot be picked up
ContainerAllocationOutcome	placement
boolean	released flag set when it is released, to know if it has already been targeted for termination
String	role Name of the role
int	roleId Role Id; matches priority in resources.json
long	startTime
int	state state from StateValues

Constructor Summary

Constructors

Constructor and Description
RoleInstance(org.apache.hadoop.yarn.api.records.Container container) Create an instance to track an allocated container
RoleInstance(ContainerAssignment assignment)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEndpoint(org.apache.hadoop.registry.client.types.Endpoint endpoint) Add an endpoint registration
Object	clone() Clone operation clones all the simple values but shares the Container object into the cloned copy -same with the output, diagnostics and env arrays.
org.apache.hadoop.yarn.api.records.ContainerId	getContainerId()
List<org.apache.hadoop.registry.client.types.Endpoint>	getEndpoints() Get the list of endpoints.
org.apache.hadoop.yarn.api.records.NodeId	getHost()
org.apache.hadoop.yarn.api.records.ContainerId	getId()
void	registerPortEndpoint(int port, String api) Register a port endpoint as an inet-addr formatted endpoint, using the hostname as the first part of the address
ContainerInformation	serialize() Serialize.
ClusterNode	toClusterNode() Build a serializable ClusterNode structure from this instance.
Messages.RoleInstanceState	toProtobuf() Generate the protobuf format of a request
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

container

public org.apache.hadoop.yarn.api.records.Container container

id

public final String id

Container ID

createTime

public long createTime

startTime

public long startTime

released

public boolean released

flag set when it is released, to know if it has already been targeted for termination

role

public String role

Name of the role

appVersion

public String appVersion

Version of the app

roleId

public int roleId

Role Id; matches priority in resources.json

state

public int state

state from StateValues

exitCode

public int exitCode

Exit code: only valid if the state >= STOPPED

command

public String command

what was the command executed?

diagnostics

public String diagnostics

Any diagnostics

output

public String[] output

What is the tail output from the executed process (or [] if not started or the log cannot be picked up

environment

public String[] environment

Any environment details

host

public String host

hostURL

public String hostURL

placement

public ContainerAllocationOutcome placement

Constructor Detail

RoleInstance

public RoleInstance(ContainerAssignment assignment)

RoleInstance

public RoleInstance(org.apache.hadoop.yarn.api.records.Container container)

Create an instance to track an allocated container

Parameters:

container - a container which must be non null, and have a non-null Id field.

Method Detail

getId

public org.apache.hadoop.yarn.api.records.ContainerId getId()

getHost

public org.apache.hadoop.yarn.api.records.NodeId getHost()

toString

public String toString()

Overrides:

toString in class Object

getContainerId

public org.apache.hadoop.yarn.api.records.ContainerId getContainerId()

toProtobuf

public Messages.RoleInstanceState toProtobuf()

Generate the protobuf format of a request

Returns:

protobuf format. This excludes the Container info

toClusterNode

public ClusterNode toClusterNode()

Build a serializable ClusterNode structure from this instance. This operation is unsynchronized.

Returns:

a serialized value.

clone

public Object clone()
             throws CloneNotSupportedException

Clone operation clones all the simple values but shares the Container object into the cloned copy -same with the output, diagnostics and env arrays.

Overrides:

clone in class Object

Returns:

a clone of the object

Throws:

CloneNotSupportedException

getEndpoints

public List<org.apache.hadoop.registry.client.types.Endpoint> getEndpoints()

Get the list of endpoints.

Returns:

the endpoint list.

addEndpoint

public void addEndpoint(org.apache.hadoop.registry.client.types.Endpoint endpoint)

Add an endpoint registration

Parameters:

endpoint - endpoint (non-null)

registerPortEndpoint

public void registerPortEndpoint(int port,
                        String api)

Register a port endpoint as an inet-addr formatted endpoint, using the hostname as the first part of the address

Parameters:

port - port port

api - API API name

serialize

public ContainerInformation serialize()

Serialize. Some data structures (e.g output) may be shared

Returns:

a serialized form for marshalling as JSON