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 request) Adds security groups to the master node of an existing EMR Cluster.
Object	addStepToCluster(Object request) Adds step to an existing EMR Cluster.
EmrCluster	createCluster(EmrClusterCreateRequest request) Creates a new EMR Cluster.
EmrCluster	getCluster(EmrClusterAlternateKeyDto emrClusterAlternateKeyDto, String emrClusterId, String emrStepId, boolean verbose, String accountId, Boolean retrieveInstanceFleets) Gets details of an existing EMR Cluster.
EmrCluster	terminateCluster(EmrClusterAlternateKeyDto emrClusterAlternateKeyDto, boolean overrideTerminationProtection, String emrClusterId, String accountId) Terminates the EMR Cluster.

Method Detail

addSecurityGroupsToClusterMaster

EmrMasterSecurityGroup addSecurityGroupsToClusterMaster(EmrMasterSecurityGroupAddRequest request)
                                                 throws Exception

Adds security groups to the master node of an existing EMR Cluster.

Parameters:

request - the EMR master security group add request

Returns:

the added EMR master security groups

Throws:

Exception - if there were any errors adding the security groups to the cluster master

addStepToCluster

Object addStepToCluster(Object request)
                 throws Exception

Adds step to an existing EMR Cluster.

There are four serializable objects supported currently. They are 1: ShellStep - For shell scripts 2: HiveStep - For hive scripts 3: HadoopJarStep - For Custom Map Reduce Jar files and 4: PigStep - For Pig scripts.

Parameters:

request - the EMR steps add request

Returns:

the EMR steps add object with added steps

Throws:

Exception - if there were any errors while adding a step to the cluster.

createCluster

EmrCluster createCluster(EmrClusterCreateRequest request)
                  throws Exception

Creates a new EMR Cluster.

Parameters:

request - the EMR cluster create request

Returns:

the created EMR cluster object

Throws:

Exception - if there were any errors while creating the cluster

getCluster

EmrCluster getCluster(EmrClusterAlternateKeyDto emrClusterAlternateKeyDto,
                      String emrClusterId,
                      String emrStepId,
                      boolean verbose,
                      String accountId,
                      Boolean retrieveInstanceFleets)
               throws Exception

Gets details of an existing EMR Cluster.

Parameters:

emrClusterAlternateKeyDto - the EMR cluster alternate key

emrClusterId - the id of the cluster to get details

emrStepId - the step id of the step to get details

verbose - parameter for whether to return detailed information

accountId - the optional AWS account that EMR cluster is running in

retrieveInstanceFleets - parameter for whether to retrieve instance fleets

Returns:

the EMR Cluster object with details

Throws:

Exception - if there were any errors

terminateCluster

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

Terminates the EMR Cluster.

Parameters:

emrClusterAlternateKeyDto - the EMR cluster alternate key

overrideTerminationProtection - parameter for whether to override termination protection

emrClusterId - the id of the cluster

accountId - the optional AWS account that EMR cluster is running in

Returns:

the terminated EMR cluster object

Throws:

Exception - if there were any errors while terminating the cluster