RoleStatus (Slider Core 0.90.2-incubating API)

java.lang.Object
- org.apache.slider.server.appmaster.state.RoleStatus

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet, Cloneable
```
public final class RoleStatus
extends Object
implements Cloneable, com.codahale.metrics.MetricSet
```
Models the ongoing status of all nodes in an application. These structures are shared across the AppState and RoleHistory structures, and must be designed for synchronous access. Atomic counters are preferred to anything which requires synchronization. Where synchronized access is good is that it allows for the whole instance to be locked, for updating multiple entries.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoleStatus.CompareByKey` Compare two role status entries by key
`static class`	`RoleStatus.CompareByName` Compare two role status entries by name

Constructor Summary

Constructors
Constructor and Description

RoleStatus(ProviderRole providerRole)

Constructors
Constructor and Description
`RoleStatus(ProviderRole providerRole)`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Integer>`	`buildStatistics()` Build the statistics map from the current data
`void`	`cancel(long count)`
`void`	`cancelOutstandingAARequest()` Cancel any outstanding AA request.
`Object`	`clone()`
`void`	`completeOutstandingAARequest()` Complete the outstanding AA request (there's no check for one in progress, caller expected to have done that).
`org.apache.hadoop.yarn.api.records.Resource`	`copyResourceRequirements(org.apache.hadoop.yarn.api.records.Resource resource)` Given a resource, set its requirements to those this role needs
`long`	`decActual()`
`long`	`decPendingAntiAffineRequests()`
`long`	`decReleasing()`
`void`	`decRequested()`
`long`	`getActual()`
`long`	`getActualAndRequested()` Get count of actual and requested containers.
`long`	`getCompleted()`
`long`	`getDelta()` Get the number of roles we are short of.
`long`	`getDesired()`
`long`	`getFailed()`
`long`	`getFailedRecently()`
`String`	`getFailureMessage()`
`int`	`getKey()`
`String`	`getLabelExpression()` Get the (possibly null) label expression for this role
`long`	`getLimitsExceeded()`
`Map<String,com.codahale.metrics.Metric>`	`getMetrics()`
`String`	`getName()`
`long`	`getNodeFailed()`
`int`	`getNodeFailureThreshold()` The number of failures on a specific node that can be tolerated before selecting a different node for placement
`OutstandingRequest`	`getOutstandingAArequest()`
`int`	`getOutstandingAARequestCount()` expose the predicate `isAARequestOutstanding()` as an integer, which is very convenient in tests
`long`	`getPendingAntiAffineRequests()`
`int`	`getPlacementPolicy()` Get the placement policy enum, from the values in `PlacementPolicy`
`long`	`getPlacementTimeoutSeconds()`
`long`	`getPreempted()`
`int`	`getPriority()`
`ProviderRole`	`getProviderRole()` Get the provider role
`long`	`getReleasing()`
`long`	`getRequested()` Get the request count.
`org.apache.hadoop.yarn.api.records.Resource`	`getResourceRequirements()`
`long`	`getStarted()`
`long`	`getStartFailed()`
`RoleStatistics`	`getStatistics()`
`long`	`getTotalRequested()`
`boolean`	`hasPlacementPolicy(int policy)`
`long`	`incActual()`
`long`	`incCompleted()`
`long`	`incPendingAntiAffineRequests(long v)`
`long`	`incReleasing()`
`long`	`incRequested()`
`void`	`incStarted()`
`void`	`incStartFailed()`
`boolean`	`isAARequestOutstanding()` Probe for an outstanding AA request being true
`boolean`	`isAntiAffinePlacement()`
`boolean`	`isExcludeFromFlexing()`
`boolean`	`isPlacementDesired()`
`boolean`	`isStrictPlacement()`
`void`	`noteFailed(boolean startupFailure, String text, ContainerOutcome outcome)` Note that a role failed, text will be used in any diagnostics if an exception is later raised.
`long`	`resetFailedRecently()` Reset the recent failure
`ComponentInformation`	`serialize()` Produced a serialized form which can be served up as JSON
`void`	`setCompleted(int completed)`
`void`	`setDesired(long desired)`
`void`	`setOutstandingAArequest(OutstandingRequest outstandingAArequest)`
`void`	`setPendingAntiAffineRequests(long pendingAntiAffineRequests)`
`void`	`setResourceRequirements(org.apache.hadoop.yarn.api.records.Resource resourceRequirements)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RoleStatus
```
public RoleStatus(ProviderRole providerRole)
```
- Method Detail
  - getMetrics
```
public Map<String,com.codahale.metrics.Metric> getMetrics()
```
    Specified by:
    
    getMetrics in interface com.codahale.metrics.MetricSet
  - getName
```
public String getName()
```
  - getKey
```
public int getKey()
```
  - getPriority
```
public int getPriority()
```
  - getPlacementPolicy
```
public int getPlacementPolicy()
```
    Get the placement policy enum, from the values in PlacementPolicy
    
    Returns:
    the placement policy for this role
  - getPlacementTimeoutSeconds
```
public long getPlacementTimeoutSeconds()
```
  - getNodeFailureThreshold
```
public int getNodeFailureThreshold()
```
    The number of failures on a specific node that can be tolerated before selecting a different node for placement
    
    Returns:
  - isExcludeFromFlexing
```
public boolean isExcludeFromFlexing()
```
  - isStrictPlacement
```
public boolean isStrictPlacement()
```
  - isAntiAffinePlacement
```
public boolean isAntiAffinePlacement()
```
  - hasPlacementPolicy
```
public boolean hasPlacementPolicy(int policy)
```
  - isPlacementDesired
```
public boolean isPlacementDesired()
```
  - getDesired
```
public long getDesired()
```
  - setDesired
```
public void setDesired(long desired)
```
  - getActual
```
public long getActual()
```
  - incActual
```
public long incActual()
```
  - decActual
```
public long decActual()
```
  - getRequested
```
public long getRequested()
```
    Get the request count.
    
    Returns:
    a count of requested containers
  - incRequested
```
public long incRequested()
```
  - cancel
```
public void cancel(long count)
```
  - decRequested
```
public void decRequested()
```
  - getReleasing
```
public long getReleasing()
```
  - incReleasing
```
public long incReleasing()
```
  - decReleasing
```
public long decReleasing()
```
  - getFailed
```
public long getFailed()
```
  - getFailedRecently
```
public long getFailedRecently()
```
  - resetFailedRecently
```
public long resetFailedRecently()
```
    Reset the recent failure
    
    Returns:
    the number of failures in the "recent" window
  - getLimitsExceeded
```
public long getLimitsExceeded()
```
  - incPendingAntiAffineRequests
```
public long incPendingAntiAffineRequests(long v)
```
  - isAARequestOutstanding
```
public boolean isAARequestOutstanding()
```
    Probe for an outstanding AA request being true
    
    Returns:
    true if there is an outstanding AA Request
  - getOutstandingAARequestCount
```
public int getOutstandingAARequestCount()
```
    expose the predicate isAARequestOutstanding() as an integer, which is very convenient in tests
    
    Returns:
    1 if there is an outstanding request; 0 if not
  - noteFailed
```
public void noteFailed(boolean startupFailure,
              String text,
              ContainerOutcome outcome)
```
    Note that a role failed, text will be used in any diagnostics if an exception is later raised.
    
    Parameters:
    startupFailure - flag to indicate this was a startup event
    text - text about the failure
    outcome - outcome of the container
  - getStartFailed
```
public long getStartFailed()
```
  - incStartFailed
```
public void incStartFailed()
```
  - getFailureMessage
```
public String getFailureMessage()
```
  - getCompleted
```
public long getCompleted()
```
  - setCompleted
```
public void setCompleted(int completed)
```
  - incCompleted
```
public long incCompleted()
```
  - getStarted
```
public long getStarted()
```
  - incStarted
```
public void incStarted()
```
  - getTotalRequested
```
public long getTotalRequested()
```
  - getPreempted
```
public long getPreempted()
```
  - getNodeFailed
```
public long getNodeFailed()
```
  - getPendingAntiAffineRequests
```
public long getPendingAntiAffineRequests()
```
  - setPendingAntiAffineRequests
```
public void setPendingAntiAffineRequests(long pendingAntiAffineRequests)
```
  - decPendingAntiAffineRequests
```
public long decPendingAntiAffineRequests()
```
  - getOutstandingAArequest
```
public OutstandingRequest getOutstandingAArequest()
```
  - setOutstandingAArequest
```
public void setOutstandingAArequest(OutstandingRequest outstandingAArequest)
```
  - completeOutstandingAARequest
```
public void completeOutstandingAARequest()
```
    Complete the outstanding AA request (there's no check for one in progress, caller expected to have done that).
  - cancelOutstandingAARequest
```
public void cancelOutstandingAARequest()
```
    Cancel any outstanding AA request. Harmless if the role is non-AA, or if there are no outstanding requests.
  - getDelta
```
public long getDelta()
```
    Get the number of roles we are short of. nodes released are ignored.
    
    Returns:
    the positive or negative number of roles to add/release. 0 means "do nothing".
  - getActualAndRequested
```
public long getActualAndRequested()
```
    Get count of actual and requested containers. This includes pending ones
    
    Returns:
    the size of the application when outstanding requests are included.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getProviderRole
```
public ProviderRole getProviderRole()
```
    Get the provider role
    
    Returns:
    the provider role
  - buildStatistics
```
public Map<String,Integer> buildStatistics()
```
    Build the statistics map from the current data
    
    Returns:
    a map for use in statistics reports
  - serialize
```
public ComponentInformation serialize()
```
    Produced a serialized form which can be served up as JSON
    
    Returns:
    a summary of the current role status.
  - getLabelExpression
```
public String getLabelExpression()
```
    Get the (possibly null) label expression for this role
    
    Returns:
    a string or null
  - getResourceRequirements
```
public org.apache.hadoop.yarn.api.records.Resource getResourceRequirements()
```
  - setResourceRequirements
```
public void setResourceRequirements(org.apache.hadoop.yarn.api.records.Resource resourceRequirements)
```
  - copyResourceRequirements
```
public org.apache.hadoop.yarn.api.records.Resource copyResourceRequirements(org.apache.hadoop.yarn.api.records.Resource resource)
```
    Given a resource, set its requirements to those this role needs
    
    Parameters:
    resource - resource to configure
    
    Returns:
    the resource
  - getStatistics
```
public RoleStatistics getStatistics()
```

Class RoleStatus

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoleStatus

Method Detail

getMetrics

getName

getKey

getPriority

getPlacementPolicy

getPlacementTimeoutSeconds

getNodeFailureThreshold

isExcludeFromFlexing

isStrictPlacement

isAntiAffinePlacement

hasPlacementPolicy

isPlacementDesired

getDesired

setDesired

getActual

incActual

decActual

getRequested

incRequested

cancel

decRequested

getReleasing

incReleasing

decReleasing

getFailed

getFailedRecently

resetFailedRecently

getLimitsExceeded

incPendingAntiAffineRequests

isAARequestOutstanding

getOutstandingAARequestCount

noteFailed

getStartFailed

incStartFailed

getFailureMessage

getCompleted

setCompleted

incCompleted

getStarted

incStarted

getTotalRequested

getPreempted

getNodeFailed

getPendingAntiAffineRequests

setPendingAntiAffineRequests

decPendingAntiAffineRequests

getOutstandingAArequest

setOutstandingAArequest

completeOutstandingAARequest

cancelOutstandingAARequest

getDelta

getActualAndRequested

toString

clone

getProviderRole

buildStatistics

serialize

getLabelExpression

getResourceRequirements

setResourceRequirements

copyResourceRequirements

getStatistics