TopologyDetails (Storm 1.2.4 API)

java.lang.Object
- org.apache.storm.scheduler.TopologyDetails

public class TopologyDetails
extends Object

Constructor Summary

Constructors
Constructor and Description
`TopologyDetails(String topologyId, Map topologyConf, StormTopology topology, int numWorkers, Map<ExecutorDetails,String> executorToComponents, int launchTime, String owner)`
`TopologyDetails(String topologyId, Map topologyConf, StormTopology topology, int numWorkers, Map<ExecutorDetails,String> executorToComponents, String owner)`
`TopologyDetails(String topologyId, Map topologyConf, StormTopology topology, int numWorkers, String owner)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addResourcesForExec(ExecutorDetails exec, Map<String,Double> resourceList)` add resource requirements for a executor
`boolean`	`equals(Object o)`
`Map<String,Component>`	`getComponents()` Returns a representation of the non-system components of the topology graph Each Component object in the returning map is populated with the list of its parents, children and execs assigned to that component.
`Map<String,Object>`	`getConf()`
`Collection<ExecutorDetails>`	`getExecutors()`
`Map<ExecutorDetails,String>`	`getExecutorToComponent()`
`String`	`getId()`
`int`	`getLaunchTime()` Get the timestamp of when this topology was launched
`String`	`getName()`
`int`	`getNumWorkers()`
`Double`	`getOffHeapMemoryRequirement(ExecutorDetails exec)` Gets the off heap memory requirement for a certain task within a topology
`Double`	`getOnHeapMemoryRequirement(ExecutorDetails exec)` Gets the on heap memory requirement for a certain task within a topology
`Map<String,Double>`	`getTaskResourceReqList(ExecutorDetails exec)` get the resources requirements for a executor
`StormTopology`	`getTopology()`
`int`	`getTopologyPriority()` get teh priority of this topology
`String`	`getTopologySubmitter()` Get the user that submitted this topology
`Double`	`getTopologyWorkerMaxHeapSize()` Get the max heap size for a worker used by this topology
`Double`	`getTotalCpuReqTask(ExecutorDetails exec)` Get the total CPU requirement for executor
`Map<ExecutorDetails,Double>`	`getTotalMemoryResourceList()` Gets the total memory resource list for a set of tasks that is part of a topology.
`Double`	`getTotalMemReqTask(ExecutorDetails exec)` Gets the total memory requirement for a task
`Double`	`getTotalRequestedCpu()` Note: The public API relevant to resource aware scheduling is unstable as of May 2015.
`Double`	`getTotalRequestedMemOffHeap()` Note: The public API relevant to resource aware scheduling is unstable as of May 2015.
`Double`	`getTotalRequestedMemOnHeap()` Note: The public API relevant to resource aware scheduling is unstable as of May 2015.
`int`	`getUpTime()` Get how long this topology has been executing
`boolean`	`hasExecInTopo(ExecutorDetails exec)` Checks if a executor is part of this topology
`int`	`hashCode()`
`Map<ExecutorDetails,String>`	`selectExecutorToComponent(Collection<ExecutorDetails> executors)`
`String`	`toString()`

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

- Constructor Detail
  - TopologyDetails
```
public TopologyDetails(String topologyId,
                       Map topologyConf,
                       StormTopology topology,
                       int numWorkers,
                       String owner)
```
  - TopologyDetails
```
public TopologyDetails(String topologyId,
                       Map topologyConf,
                       StormTopology topology,
                       int numWorkers,
                       Map<ExecutorDetails,String> executorToComponents,
                       String owner)
```
  - TopologyDetails
```
public TopologyDetails(String topologyId,
                       Map topologyConf,
                       StormTopology topology,
                       int numWorkers,
                       Map<ExecutorDetails,String> executorToComponents,
                       int launchTime,
                       String owner)
```
- Method Detail
  - getId
```
public String getId()
```
  - getName
```
public String getName()
```
  - getConf
```
public Map<String,Object> getConf()
```
  - getNumWorkers
```
public int getNumWorkers()
```
  - getTopology
```
public StormTopology getTopology()
```
  - getExecutorToComponent
```
public Map<ExecutorDetails,String> getExecutorToComponent()
```
  - selectExecutorToComponent
```
public Map<ExecutorDetails,String> selectExecutorToComponent(Collection<ExecutorDetails> executors)
```
  - getExecutors
```
public Collection<ExecutorDetails> getExecutors()
```
  - getComponents
```
public Map<String,Component> getComponents()
```
    Returns a representation of the non-system components of the topology graph Each Component object in the returning map is populated with the list of its parents, children and execs assigned to that component.
    
    Returns:
    
    a map of components
  - getOnHeapMemoryRequirement
```
public Double getOnHeapMemoryRequirement(ExecutorDetails exec)
```
    Gets the on heap memory requirement for a certain task within a topology
    
    Parameters:
    
    exec - the executor the inquiry is concerning.
    
    Returns:
    
    Double the amount of on heap memory requirement for this exec in topology topoId.
  - getOffHeapMemoryRequirement
```
public Double getOffHeapMemoryRequirement(ExecutorDetails exec)
```
    Gets the off heap memory requirement for a certain task within a topology
    
    Parameters:
    
    exec - the executor the inquiry is concerning.
    
    Returns:
    
    Double the amount of off heap memory requirement for this exec in topology topoId.
  - getTotalMemReqTask
```
public Double getTotalMemReqTask(ExecutorDetails exec)
```
    Gets the total memory requirement for a task
    
    Parameters:
    
    exec - the executor the inquiry is concerning.
    
    Returns:
    
    Double the total memory requirement for this exec in topology topoId.
  - getTotalMemoryResourceList
```
public Map<ExecutorDetails,Double> getTotalMemoryResourceList()
```
    Gets the total memory resource list for a set of tasks that is part of a topology.
    
    Returns:
    
    Map<ExecutorDetails, Double> a map of the total memory requirement for all tasks in topology topoId.
  - getTotalCpuReqTask
```
public Double getTotalCpuReqTask(ExecutorDetails exec)
```
    Get the total CPU requirement for executor
    
    Returns:
    
    Double the total about of cpu requirement for executor
  - getTotalRequestedMemOnHeap
```
public Double getTotalRequestedMemOnHeap()
```
    Note: The public API relevant to resource aware scheduling is unstable as of May 2015. We reserve the right to change them.
    
    Returns:
    
    the total on-heap memory requested for this topology
  - getTotalRequestedMemOffHeap
```
public Double getTotalRequestedMemOffHeap()
```
    Note: The public API relevant to resource aware scheduling is unstable as of May 2015. We reserve the right to change them.
    
    Returns:
    
    the total off-heap memory requested for this topology
  - getTotalRequestedCpu
```
public Double getTotalRequestedCpu()
```
    Note: The public API relevant to resource aware scheduling is unstable as of May 2015. We reserve the right to change them.
    
    Returns:
    
    the total cpu requested for this topology
  - getTaskResourceReqList
```
public Map<String,Double> getTaskResourceReqList(ExecutorDetails exec)
```
    get the resources requirements for a executor
    
    Parameters:
    
    exec -
    
    Returns:
    
    a map containing the resource requirements for this exec
  - hasExecInTopo
```
public boolean hasExecInTopo(ExecutorDetails exec)
```
    Checks if a executor is part of this topology
    
    Returns:
    
    Boolean whether or not a certain ExecutorDetail is included in the resourceList.
  - addResourcesForExec
```
public void addResourcesForExec(ExecutorDetails exec,
                                Map<String,Double> resourceList)
```
    add resource requirements for a executor
  - getTopologyWorkerMaxHeapSize
```
public Double getTopologyWorkerMaxHeapSize()
```
    Get the max heap size for a worker used by this topology
    
    Returns:
    
    the worker max heap size
  - getTopologySubmitter
```
public String getTopologySubmitter()
```
    Get the user that submitted this topology
  - getTopologyPriority
```
public int getTopologyPriority()
```
    get teh priority of this topology
  - getLaunchTime
```
public int getLaunchTime()
```
    Get the timestamp of when this topology was launched
  - getUpTime
```
public int getUpTime()
```
    Get how long this topology has been executing
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object

Class TopologyDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopologyDetails

TopologyDetails

TopologyDetails

Method Detail

getId

getName

getConf

getNumWorkers

getTopology

getExecutorToComponent

selectExecutorToComponent

getExecutors

getComponents

getOnHeapMemoryRequirement

getOffHeapMemoryRequirement

getTotalMemReqTask

getTotalMemoryResourceList

getTotalCpuReqTask

getTotalRequestedMemOnHeap

getTotalRequestedMemOffHeap

getTotalRequestedCpu

getTaskResourceReqList

hasExecInTopo

addResourcesForExec

getTopologyWorkerMaxHeapSize

getTopologySubmitter

getTopologyPriority

getLaunchTime

getUpTime

toString

hashCode

equals