Package com.teracloud.streams.rest

Class ProcessingElement

java.lang.Object
com.teracloud.streams.rest.Element
com.teracloud.streams.rest.ProcessingElement
public class ProcessingElement extends Element
An object describing an Streams Processing Element

  • Constructor Details

    • ProcessingElement

      public ProcessingElement()

  • Method Details

    • getMetrics

      public List<Metric> getMetrics() throws IOException
      Gets a list of metrics for this processing element
      Returns:
      List of Streams Metrics
      Throws:
      IOException

    • getInputPorts

      public List<PEInputPort> getInputPorts() throws IOException
      Gets a list of processing element input ports for this processing element
      Returns:
      List of Processing Element Input Ports
      Throws:
      IOException

    • getOperators

      public List<Operator> getOperators() throws IOException
      Gets a list of operators for this processing element
      Returns:
      List of Streams Operators
      Throws:
      IOException

    • getOutputPorts

      public List<PEOutputPort> getOutputPorts() throws IOException
      Gets a list of processing element output ports for this processing element
      Returns:
      List of Processing Element Output Ports
      Throws:
      IOException

    • getCurrentWorkingPath

      public String getCurrentWorkingPath()
      Gets the current working path of the processing element
      Returns:
      the current working path

    • getHealth

      public String getHealth()
      Gets the health indicator for this processing element
      Returns:
      the health indicator that contains one of the following values:
      • healthy
      • partiallyHealthy
      • partiallyUnhealthy
      • unhealthy
      • unknown

    • getId

      public String getId()
      Gets the id of this processing element
      Returns:
      the processing element id

    • getIndexWithinJob

      public long getIndexWithinJob()
      Gets the index of this processing element within the Job
      Returns:
      processing element index as a long

    • getLaunchCount

      public int getLaunchCount()
      Gets the number of times this processing element was started manually or automatically because of failures
      Returns:
      number of times the processing element was started as an int

    • getOptionalConnections

      public String getOptionalConnections()
      Gets the status of optional connections for this processing element.
      Returns:
      the optional connection status that contains one of the following values:
      • connected
      • disconnected
      • partiallyConnected
      • unknown

    • getOsCapabilities

      public List<String> getOsCapabilities()
      Gets a list of the operating system capabilities
      Returns:
      List of the operating system capabilities

    • getPendingTracingLevel

      public String getPendingTracingLevel()
      Describes a pending change to the granularity of the trace information that is stored for this processing element.
      Returns:
      the pending trace level change that contains one of the following values:
      • off
      • debug
      • error
      • trace
      a null value indicates no pending change to the trace level

    • getProcessId

      public String getProcessId()
      Gets the operating system process ID for this processing element
      Returns:
      the operating sytem process ID

    • getRelocatable

      public boolean getRelocatable()
      Indicates whether or not this processing element can be relocated to a different resource
      Returns:
      boolean indicating whether or not relocation is possible

    • getRequiredConnections

      public String getRequiredConnections()
      Status of the required connections for this processing element.
      Returns:
      required connection status that contains one of the following values:
      • connected
      • disconnected
      • partiallyConnected
      • unknown

    • getResourceTags

      public List<String> getResourceTags()
      Gets a list of resource tags for this processing element
      Returns:
      List of resource tags

    • getResourceType

      public String getResourceType()
      Identifies the REST resource type
      Returns:
      "pe"

    • getRestartable

      public boolean getRestartable()
      Indicates whether or not this processing element can be restarted
      Returns:
      the restart indicator as a boolean

    • getStatus

      public String getStatus()
      Gets the status of this processing element
      Returns:
      the processing element status

    • getStatusReason

      public String getStatusReason()
      Gets additional status for this processing element
      Returns:
      any addition status for this processing element

    • getTracingLevel

      public String getTracingLevel()
      Gets the granularity of the tracing level for this processing element
      Returns:
      the current tracing level that contains one of the following values:
      • off
      • debug
      • error
      • trace

    • getResourceAllocation

      public ResourceAllocation getResourceAllocation() throws IOException
      Gets the resource allocation for this processing element.
      Returns:
      resource allocation
      Throws:
      IOException
      Since:
      1.9