Class: Amazon::Coral::ElasticMapReduceClient

Inherits:

Object

• Object
• Amazon::Coral::ElasticMapReduceClient

Defined in:

lib/amazon/coral/elasticmapreduceclient.rb

Overview

Client interface for calling ElasticMapReduce.

The client supports two mechanisms to invoke each remote service call: a simple approach which directly calls the remote service, or a Call based mechanism that allows you to control aspects of the outgoing request such as request-id and identity attributes.

Each instance of a client interface is backed by an Orchestrator object which manages the processing of each request to the remote service. Clients can be instantiated with a custom orchestrator or with presets corresponding to particular protocols. Inputs and return values to the direct service-call methods and the Call.call methods are hashes.

Class Method Summary

• .new_aws_query(args) ⇒ Object

  Instantiates the client with an orchestrator configured for use with AWS/QUERY.

Instance Method Summary

• #AddInstanceGroups(input = {}) ⇒ Object

  Shorthand method to invoke the AddInstanceGroups operation:.

• #AddJobFlowSteps(input = {}) ⇒ Object

  Shorthand method to invoke the AddJobFlowSteps operation:.

• #DescribeJobFlows(input = {}) ⇒ Object

  Shorthand method to invoke the DescribeJobFlows operation:.

• #initialize(orchestrator) ⇒ ElasticMapReduceClient constructor

  Construct a new client.

• #ModifyInstanceGroups(input = {}) ⇒ Object
• #newAddInstanceGroupsCall ⇒ Object

  Instantiates a call object to invoke the AddInstanceGroups operation:.

• #newAddJobFlowStepsCall ⇒ Object

  Instantiates a call object to invoke the AddJobFlowSteps operation:.

• #newDescribeJobFlowsCall ⇒ Object

  Instantiates a call object to invoke the DescribeJobFlows operation:.

• #newModifyInstanceGroupsCall ⇒ Object
• #newRunJobFlowCall ⇒ Object

  Instantiates a call object to invoke the RunJobFlow operation:.

• #newSetTerminationProtectionCall ⇒ Object

  Instantiates a call object to invoke the SetTerminationProtection operation:.

• #newTerminateJobFlowsCall ⇒ Object

  Instantiates a call object to invoke the TerminateJobFlows operation:.

• #RunJobFlow(input = {}) ⇒ Object

  Shorthand method to invoke the RunJobFlow operation:.

• #SetTerminationProtection(input = {}) ⇒ Object

  Shorthand method to invoke the SetTerminationProtection operation:.

• #TerminateJobFlows(input = {}) ⇒ Object

  Shorthand method to invoke the TerminateJobFlows operation:.

Constructor Details

#initialize(orchestrator) ⇒ ElasticMapReduceClient

Construct a new client. Takes an orchestrator through which to process requests. See additional constructors below to use pre-configured orchestrators for specific protocols.

orchestrator

The Orchestrator is responsible for actually making the remote service call. Clients construct requests, hand them off to the orchestrator, and receive responses in return.

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 29

def initialize(orchestrator)
  @addJobFlowStepsDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'AddJobFlowSteps')
  @addInstanceGroupsDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'AddInstanceGroups')
  @terminateJobFlowsDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'TerminateJobFlows')
  @setTerminationProtectionDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'SetTerminationProtection')
  @describeJobFlowsDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'DescribeJobFlows')
  @runJobFlowDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'RunJobFlow')
  @modifyInstanceGroupsDispatcher = Dispatcher.new(orchestrator, 'ElasticMapReduce', 'ModifyInstanceGroups')
end

Class Method Details

.new_aws_query(args) ⇒ Object

Instantiates the client with an orchestrator configured for use with AWS/QUERY. Use of this constructor is deprecated in favor of using the AwsQuery class:

client = ElasticMapReduceClient.new(AwsQuery.new_orchestrator(args))

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 179

def ElasticMapReduceClient.new_aws_query(args)
  require 'amazon/coral/awsquery'
  ElasticMapReduceClient.new(AwsQuery.new_orchestrator(args))
end

Instance Method Details

#AddInstanceGroups(input = {}) ⇒ Object

Shorthand method to invoke the AddInstanceGroups operation:

Example usage:

my_client.AddInstanceGroups(my_input)

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 137

def AddInstanceGroups(input = {})
  newAddInstanceGroupsCall.call(input)
end

#AddJobFlowSteps(input = {}) ⇒ Object

Shorthand method to invoke the AddJobFlowSteps operation:

Example usage:

my_client.AddJobFlowSteps(my_input)

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 129

def AddJobFlowSteps(input = {})
  newAddJobFlowStepsCall.call(input)
end

#DescribeJobFlows(input = {}) ⇒ Object

Shorthand method to invoke the DescribeJobFlows operation:

Example usage:

my_output = my_client.DescribeJobFlows(my_input)

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 158

def DescribeJobFlows(input = {})
  newDescribeJobFlowsCall.call(input)
end

#ModifyInstanceGroups(input = {}) ⇒ Object

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 171

def ModifyInstanceGroups(input = {})
  newModifyInstanceGroupsCall.call(input)
end

#newAddInstanceGroupsCall ⇒ Object

Instantiates a call object to invoke the AddInstanceGroups operation:

Example usage:

my_call = my_client.newAddInstanceGroupsCall
# set identity information if needed
my_call.identity[:aws_access_key] = my_access_key
my_call.identity[:aws_secret_key] = my_secret_key
# make the remote call
my_call.call(my_input)
# retrieve the request-id returned by the server
my_request_id = my_call.request_id

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 66

def newAddInstanceGroupsCall
  Call.new(@addInstanceGroupsDispatcher)
end

#newAddJobFlowStepsCall ⇒ Object

Instantiates a call object to invoke the AddJobFlowSteps operation:

Example usage:

my_call = my_client.newAddJobFlowStepsCall
# set identity information if needed
my_call.identity[:aws_access_key] = my_access_key
my_call.identity[:aws_secret_key] = my_secret_key
# make the remote call
my_call.call(my_input)
# retrieve the request-id returned by the server
my_request_id = my_call.request_id

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 51

def newAddJobFlowStepsCall
  Call.new(@addJobFlowStepsDispatcher)
end

#newDescribeJobFlowsCall ⇒ Object

Instantiates a call object to invoke the DescribeJobFlows operation:

Example usage:

my_call = my_client.newDescribeJobFlowsCall
# set identity information if needed
my_call.identity[:aws_access_key] = my_access_key
my_call.identity[:aws_secret_key] = my_secret_key
# make the remote call
my_output = my_call.call(my_input)
# retrieve the request-id returned by the server
my_request_id = my_call.request_id

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 101

def newDescribeJobFlowsCall
  Call.new(@describeJobFlowsDispatcher)
end

#newModifyInstanceGroupsCall ⇒ Object

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 120

def newModifyInstanceGroupsCall
  Call.new(@modifyInstanceGroupsDispatcher)
end

#newRunJobFlowCall ⇒ Object

Instantiates a call object to invoke the RunJobFlow operation:

Example usage:

my_call = my_client.newRunJobFlowCall
# set identity information if needed
my_call.identity[:aws_access_key] = my_access_key
my_call.identity[:aws_secret_key] = my_secret_key
# make the remote call
my_output = my_call.call(my_input)
# retrieve the request-id returned by the server
my_request_id = my_call.request_id

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 116

def newRunJobFlowCall
  Call.new(@runJobFlowDispatcher)
end

#newSetTerminationProtectionCall ⇒ Object

Instantiates a call object to invoke the SetTerminationProtection operation:

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 86

def newSetTerminationProtectionCall
  Call.new(@setTerminationProtectionDispatcher)
end

#newTerminateJobFlowsCall ⇒ Object

Instantiates a call object to invoke the TerminateJobFlows operation:

Example usage:

my_call = my_client.newTerminateJobFlowsCall
# set identity information if needed
my_call.identity[:aws_access_key] = my_access_key
my_call.identity[:aws_secret_key] = my_secret_key
# make the remote call
my_call.call(my_input)
# retrieve the request-id returned by the server
my_request_id = my_call.request_id

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 81

def newTerminateJobFlowsCall
  Call.new(@terminateJobFlowsDispatcher)
end

#RunJobFlow(input = {}) ⇒ Object

Shorthand method to invoke the RunJobFlow operation:

Example usage:

my_output = my_client.RunJobFlow(my_input)

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 166

def RunJobFlow(input = {})
  newRunJobFlowCall.call(input)
end

#SetTerminationProtection(input = {}) ⇒ Object

Shorthand method to invoke the SetTerminationProtection operation:

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 150

def SetTerminationProtection(input = {})
  newSetTerminationProtectionCall.call(input)
end

#TerminateJobFlows(input = {}) ⇒ Object

Shorthand method to invoke the TerminateJobFlows operation:

Example usage:

my_client.TerminateJobFlows(my_input)

# File 'lib/amazon/coral/elasticmapreduceclient.rb', line 145

def TerminateJobFlows(input = {})
  newTerminateJobFlowsCall.call(input)
end