ApiYarnApplication (Cloudera Manager API (5.12.0))

java.lang.Object
- com.cloudera.api.model.ApiYarnApplication

public class ApiYarnApplication
extends Object

Represents a Yarn application

Constructor Summary

Constructors
Constructor and Description
`ApiYarnApplication()`
ApiYarnApplication(String applicationId, String name, Date startTime, Date endTime, String user, String pool, String state, Double progress, ApiMr2AppInformation mr2AppInfo, Map<String,String> attributes, List<String> applicationTags, Long allocatedMemorySeconds, Long allocatedVcoreSeconds, Integer allocatedMB, Integer allocatedVCores, Integer runningContainers, Double containerUsedMemorySeconds, Double containerUsedMemoryMax, Double containerUsedCpuSeconds, Double containerUsedVcoreSeconds, Double containerAllocatedMemorySeconds, Double containerAllocatedVcoreSeconds)

Method Summary

Methods
Modifier and Type	Method and Description
`Integer`	`getAllocatedMB()` The sum of memory in MB allocated to the application's running containers Available since v12.
`Long`	`getAllocatedMemorySeconds()` Allocated memory to the application in units of mb-secs.
`Integer`	`getAllocatedVCores()` The sum of virtual cores allocated to the application's running containers Available since v12.
`Long`	`getAllocatedVcoreSeconds()` Allocated vcore-secs to the application.
`String`	`getApplicationId()` The application id.
`List<String>`	`getApplicationTags()` List of YARN application tags.
`Map<String,String>`	`getAttributes()` A map of additional application attributes which is generated by Cloudera Manager.
`Double`	`getContainerAllocatedMemorySeconds()` Total memory (in mb-secs) allocated to containers launched by the YARN application.
`Double`	`getContainerAllocatedVcoreSeconds()` Total vcore-secs allocated to containers launched by the YARN application.
`Double`	`getContainerUsedCpuSeconds()` Actual CPU (in percent-secs) used by containers launched by the YARN application.
`Double`	`getContainerUsedMemoryMax()` Maximum memory used by containers launched by the YARN application.
`Double`	`getContainerUsedMemorySeconds()` Actual memory (in MB-secs) used by containers launched by the YARN application.
`Double`	`getContainerUsedVcoreSeconds()` Actual VCore-secs used by containers launched by the YARN application.
`Date`	`getEndTime()` The time the application finished.
`ApiMr2AppInformation`	`getMr2AppInformation()`
`String`	`getName()` The name of the application.
`String`	`getPool()` The pool the application was submitted to.
`Double`	`getProgress()` The progress, as a percentage, the application has made.
`Integer`	`getRunningContainers()` The number of containers currently running for the application Available since v12.
`Date`	`getStartTime()` The time the application was submitted.
`String`	`getState()`
`String`	`getUser()` The user who submitted the application.
`void`	`setAllocatedMB(Integer allocatedMB)`
`void`	`setAllocatedMemorySeconds(Long allocatedMemorySeconds)`
`void`	`setAllocatedVCores(Integer allocatedVCores)`
`void`	`setAllocatedVcoreSeconds(Long allocatedVcoreSeconds)`
`void`	`setApplicationId(String applicationId)`
`void`	`setApplicationTags(List<String> applicationTags)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setContainerAllocatedMemorySeconds(Double containerAllocatedMemorySeconds)`
`void`	`setContainerAllocatedVcoreSeconds(Double containerAllocatedVcoreSeconds)`
`void`	`setContainerUsedCpuSeconds(Double containerUsedCpuSeconds)`
`void`	`setContainerUsedMemoryMax(Double containerUsedMemoryMax)`
`void`	`setContainerUsedMemorySeconds(Double containerUsedMemorySeconds)`
`void`	`setContainerUsedVcoreSeconds(Double containerUsedVcoreSeconds)`
`void`	`setEndTime(Date endTime)`
`void`	`setMr2AppInformation(ApiMr2AppInformation mr2AppInfo)`
`void`	`setName(String name)`
`void`	`setPool(String pool)`
`void`	`setProgress(Double progress)`
`void`	`setRunningContainers(Integer runningContainers)`
`void`	`setStartTime(Date startTime)`
`void`	`setState(String state)`
`void`	`setUser(String user)`
`String`	`toString()`

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

Constructor Detail

ApiYarnApplication
```
public ApiYarnApplication()
```

ApiYarnApplication

public ApiYarnApplication(String applicationId,
                  String name,
                  Date startTime,
                  Date endTime,
                  String user,
                  String pool,
                  String state,
                  Double progress,
                  ApiMr2AppInformation mr2AppInfo,
                  Map<String,String> attributes,
                  List<String> applicationTags,
                  Long allocatedMemorySeconds,
                  Long allocatedVcoreSeconds,
                  Integer allocatedMB,
                  Integer allocatedVCores,
                  Integer runningContainers,
                  Double containerUsedMemorySeconds,
                  Double containerUsedMemoryMax,
                  Double containerUsedCpuSeconds,
                  Double containerUsedVcoreSeconds,
                  Double containerAllocatedMemorySeconds,
                  Double containerAllocatedVcoreSeconds)

Method Detail
- getAllocatedMB
```
public Integer getAllocatedMB()
```
  The sum of memory in MB allocated to the application's running containers Available since v12.
- setAllocatedMB
```
public void setAllocatedMB(Integer allocatedMB)
```
- getAllocatedVCores
```
public Integer getAllocatedVCores()
```
  The sum of virtual cores allocated to the application's running containers Available since v12.
- setAllocatedVCores
```
public void setAllocatedVCores(Integer allocatedVCores)
```
- getRunningContainers
```
public Integer getRunningContainers()
```
  The number of containers currently running for the application Available since v12.
- setRunningContainers
```
public void setRunningContainers(Integer runningContainers)
```
- getApplicationTags
```
public List<String> getApplicationTags()
```
  List of YARN application tags. Available since v12.
- setApplicationTags
```
public void setApplicationTags(List<String> applicationTags)
```
- getAllocatedMemorySeconds
```
public Long getAllocatedMemorySeconds()
```
  Allocated memory to the application in units of mb-secs. Available since v12.
- setAllocatedMemorySeconds
```
public void setAllocatedMemorySeconds(Long allocatedMemorySeconds)
```
- getAllocatedVcoreSeconds
```
public Long getAllocatedVcoreSeconds()
```
  Allocated vcore-secs to the application. Available since v12.
- setAllocatedVcoreSeconds
```
public void setAllocatedVcoreSeconds(Long allocatedVcoreSeconds)
```
- getApplicationId
```
public String getApplicationId()
```
  The application id.
- setApplicationId
```
public void setApplicationId(String applicationId)
```
- getName
```
public String getName()
```
  The name of the application.
- setName
```
public void setName(String name)
```
- getStartTime
```
public Date getStartTime()
```
  The time the application was submitted.
- setStartTime
```
public void setStartTime(Date startTime)
```
- getEndTime
```
public Date getEndTime()
```
  The time the application finished. If the application hasn't finished this will return null.
- setEndTime
```
public void setEndTime(Date endTime)
```
- getUser
```
public String getUser()
```
  The user who submitted the application.
- setUser
```
public void setUser(String user)
```
- getPool
```
public String getPool()
```
  The pool the application was submitted to.
- setPool
```
public void setPool(String pool)
```
- getProgress
```
public Double getProgress()
```
  The progress, as a percentage, the application has made. This is only set if the application is currently executing.
- setProgress
```
public void setProgress(Double progress)
```
- getAttributes
```
public Map<String,String> getAttributes()
```
  A map of additional application attributes which is generated by Cloudera Manager. For example MR2 job counters are exposed as key/value pairs here. For more details see the Cloudera Manager documentation.
- setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
- getMr2AppInformation
```
public ApiMr2AppInformation getMr2AppInformation()
```
- setMr2AppInformation
```
public void setMr2AppInformation(ApiMr2AppInformation mr2AppInfo)
```
- getState
```
public String getState()
```
- setState
```
public void setState(String state)
```
- getContainerUsedMemorySeconds
```
public Double getContainerUsedMemorySeconds()
```
  Actual memory (in MB-secs) used by containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics. Available since v12.
- setContainerUsedMemorySeconds
```
public void setContainerUsedMemorySeconds(Double containerUsedMemorySeconds)
```
- getContainerUsedMemoryMax
```
public Double getContainerUsedMemoryMax()
```
  Maximum memory used by containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics Available since v16
- setContainerUsedMemoryMax
```
public void setContainerUsedMemoryMax(Double containerUsedMemoryMax)
```
- getContainerUsedCpuSeconds
```
public Double getContainerUsedCpuSeconds()
```
  Actual CPU (in percent-secs) used by containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics. Available since v12.
- setContainerUsedCpuSeconds
```
public void setContainerUsedCpuSeconds(Double containerUsedCpuSeconds)
```
- getContainerUsedVcoreSeconds
```
public Double getContainerUsedVcoreSeconds()
```
  Actual VCore-secs used by containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics. Available since v12.
- setContainerUsedVcoreSeconds
```
public void setContainerUsedVcoreSeconds(Double containerUsedVcoreSeconds)
```
- getContainerAllocatedMemorySeconds
```
public Double getContainerAllocatedMemorySeconds()
```
  Total memory (in mb-secs) allocated to containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics. Available since v12.
- setContainerAllocatedMemorySeconds
```
public void setContainerAllocatedMemorySeconds(Double containerAllocatedMemorySeconds)
```
- getContainerAllocatedVcoreSeconds
```
public Double getContainerAllocatedVcoreSeconds()
```
  Total vcore-secs allocated to containers launched by the YARN application. Computed by running a MapReduce job from Cloudera Service Monitor to aggregate YARN usage metrics. Available since v12.
- setContainerAllocatedVcoreSeconds
```
public void setContainerAllocatedVcoreSeconds(Double containerAllocatedVcoreSeconds)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class ApiYarnApplication

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiYarnApplication

ApiYarnApplication

Method Detail

getAllocatedMB

setAllocatedMB

getAllocatedVCores

setAllocatedVCores

getRunningContainers

setRunningContainers

getApplicationTags

setApplicationTags

getAllocatedMemorySeconds

setAllocatedMemorySeconds

getAllocatedVcoreSeconds

setAllocatedVcoreSeconds

getApplicationId

setApplicationId

getName

setName

getStartTime

setStartTime

getEndTime

setEndTime

getUser

setUser

getPool

setPool

getProgress

setProgress

getAttributes

setAttributes

getMr2AppInformation

setMr2AppInformation

getState

setState

getContainerUsedMemorySeconds

setContainerUsedMemorySeconds

getContainerUsedMemoryMax

setContainerUsedMemoryMax

getContainerUsedCpuSeconds

setContainerUsedCpuSeconds

getContainerUsedVcoreSeconds

setContainerUsedVcoreSeconds

getContainerAllocatedMemorySeconds

setContainerAllocatedMemorySeconds

getContainerAllocatedVcoreSeconds

setContainerAllocatedVcoreSeconds

toString