org.finra.herd.service

Interface EmrService

All Known Implementing Classes:

EmrServiceImpl

public interface EmrService

The EMR service.

Method Summary

Modifier and Type	Method and Description
EmrMasterSecurityGroup	addSecurityGroupsToClusterMaster(EmrMasterSecurityGroupAddRequest emrMasterSecurityGroupAddRequest)
Object	addStepToCluster(Object emrStepAddRequest)
EmrCluster	createCluster(EmrClusterCreateRequest request)
EmrCluster	getCluster(EmrClusterAlternateKeyDto alternateKey, String emrClusterId, String emrStepId, boolean verbose, boolean retrieveOozieJobs, String accountId)
OozieWorkflowJob	getEmrOozieWorkflowJob(String namespace, String emrClusterDefinitionName, String emrClusterName, String oozieWorkflowJobId, Boolean verbose, String emrClusterId, String accountId) Retrieves an EMR cluster's oozie job by its ID.
OozieWorkflowJob	runOozieWorkflow(RunOozieWorkflowRequest request)
EmrCluster	terminateCluster(EmrClusterAlternateKeyDto emrClusterAlternateKeyDto, boolean overrideTerminationProtection, String emrClusterId, String accountId)

Method Detail

getCluster

EmrCluster getCluster(EmrClusterAlternateKeyDto alternateKey,
                      String emrClusterId,
                      String emrStepId,
                      boolean verbose,
                      boolean retrieveOozieJobs,
                      String accountId)
               throws Exception

Throws:

Exception

createCluster

EmrCluster createCluster(EmrClusterCreateRequest request)
                  throws Exception

Throws:

Exception

terminateCluster

EmrCluster terminateCluster(EmrClusterAlternateKeyDto emrClusterAlternateKeyDto,
                            boolean overrideTerminationProtection,
                            String emrClusterId,
                            String accountId)
                     throws Exception

Throws:

Exception

addStepToCluster

Object addStepToCluster(Object emrStepAddRequest)
                 throws Exception

Throws:

Exception

addSecurityGroupsToClusterMaster

EmrMasterSecurityGroup addSecurityGroupsToClusterMaster(EmrMasterSecurityGroupAddRequest emrMasterSecurityGroupAddRequest)
                                                 throws Exception

Throws:

Exception

runOozieWorkflow

OozieWorkflowJob runOozieWorkflow(RunOozieWorkflowRequest request)
                           throws Exception

Throws:

Exception

getEmrOozieWorkflowJob

OozieWorkflowJob getEmrOozieWorkflowJob(String namespace,
                                        String emrClusterDefinitionName,
                                        String emrClusterName,
                                        String oozieWorkflowJobId,
                                        Boolean verbose,
                                        String emrClusterId,
                                        String accountId)
                                 throws Exception

Retrieves an EMR cluster's oozie job by its ID. The EMR cluster must have been created through herd for the retrieval to be successful. A verbose flag may be set to true to retrieve action details of the workflow.

Parameters:

namespace - EMR cluster namespace

emrClusterDefinitionName - EMR cluster definition name

emrClusterName - EMR cluster name

oozieWorkflowJobId - Oozie workflow job ID

verbose - true to retrieve more details, false otherwise. Defaults to false.

emrClusterId - The EMR cluster ID

accountId - account Id

Returns:

Oozie workflow details

Throws:

Exception - when an error occurs. Most user errors would be a runtime exception.