Check EMR Cluster

Provides details on an existing EMR cluster.

Delegate Class

org.finra.dm.service.activiti.task.CheckEmrCluster

Input Parameters

Name	Required	Accepted Values	Default Value	Case Sensitive	Description
namespace	Y			N	The name of a valid namespace known by the system.
emrClusterDefinitionName	Y			N	The name of EMR definition. Available definitions are defined EMR Cluster Definition.
emrClusterName	Y			N	The name of EMR cluster.
emrClusterId	N			Y	The EMR cluster Id. If provided, status of the specific cluster if returned. If not provided, status of an Active cluster with the name is returned.
emrStepId	N			Y	An EMR step Id for which status/details are being requested.
verbose	N	true, false	false	N	If "true", detailed information such as step details will be returned. Otherwise, only Id, StepName and Status will be returned in activeStep and Step.
retrieveOozieJobs	N	true, false	false	N	If "true", retrieves first 100 jobs in RUNNING status. Otherwise, no Oozie jobs are retrieved.

Output Parameters

Name	Description
{taskId}_emrClusterId	Id of the EMR cluster that was created, if a cluster with same applicationName, emrClusterDefinitionName and emrClusterName already exists, returns the existing cluster Id.
{taskId}_emrClusterStatus	Current status of the EMR cluster.
{taskId}_activeStep_id	Id of active step on the cluster.
{taskId}_activeStep_stepName	Name of active step on the cluster.
{taskId}_activeStep_jarLocation	Jar location of active step on the cluster.
{taskId}_activeStep_mainClass	Main class of active step on the cluster.
{taskId}_activeStep_scriptArguments	Arguments of active step on the cluster delimited by the pipe character ( | ).
{taskId}_activeStep_continueOnError	Continue on error value of active step on the cluster.
{taskId}_activeStep_status	Status of active step on the cluster.
{taskId}_step_id	Id of step on the cluster.
{taskId}_step_stepName	Name of step on the cluster.
{taskId}_step_jarLocation	Jar locatiion of step on the cluster.
{taskId}_step_mainClass	Main class of step on the cluster.
{taskId}_step_scriptArguments	Arguments of step on the cluster delimited by the pipe character ( | ).
{taskId}_step_continueOnError	Continue on error value of step on the cluster.
{taskId}_step_status	Status of step on the cluster.
{taskId}_oozie_workflow_jobs	JSON object for the Oozie jobs.

Sample Usage in Activiti XML

With emrStepId and verbose=true

<serviceTask id="checkClusterServiceTask" name="Check Cluster" activiti:class="org.finra.dm.service.activiti.task.CheckEmrCluster">
   <extensionElements>
      <activiti:field name="namespace" stringValue="testNamespace"/>
      <activiti:field name="emrClusterDefinitionName" expression="${emrClusterDefinitionName}"/>
      <activiti:field name="emrClusterName" expression="${clusterName}"/>
      <activiti:field name="emrStepId" expression="${emrStepId}"/>
      <activiti:field name="verbose" stringValue="true"/>
   </extensionElements>
</serviceTask>

With no emrStepId specified and verbose=true

<serviceTask id="checkClusterServiceTask" name="Check Cluster" activiti:class="org.finra.dm.service.activiti.task.CheckEmrCluster">
   <extensionElements>
      <activiti:field name="namespace" stringValue="testNamespace"/>
      <activiti:field name="emrClusterDefinitionName" expression="${emrClusterDefinitionName}"/>
      <activiti:field name="emrClusterName" expression="${clusterName}"/>
      <activiti:field name="verbose" stringValue="true"/>
   </extensionElements>
</serviceTask>

With emrStepId and no verbose specified

<serviceTask id="checkClusterServiceTask" name="Check Cluster" activiti:class="org.finra.dm.service.activiti.task.CheckEmrCluster">
   <extensionElements>
      <activiti:field name="namespace" stringValue="testNamespace"/>
      <activiti:field name="emrClusterDefinitionName" expression="${emrClusterDefinitionName}"/>
      <activiti:field name="emrClusterName" expression="${clusterName}"/>
      <activiti:field name="emrStepId" expression="${emrStepId}"/>
   </extensionElements>
</serviceTask>