Class: Qubole::Command

Inherits:

OpenStruct

• Object
• OpenStruct
• Qubole::Command

Defined in:

lib/qubole/command.rb

Direct Known Subclasses

Qubole::Commands::Composite, Qubole::Commands::DbExport, Qubole::Commands::DbImport, Qubole::Commands::DbTapQuery, Qubole::Commands::Hadoop, Qubole::Commands::Hive, Qubole::Commands::Pig, Qubole::Commands::Presto, Qubole::Commands::Shell, Qubole::Commands::Spark

Class Method Summary

• .find(id) ⇒ Command

  Find command by id.

• .page(page, opts = {}) ⇒ Array<Command>

  Paginated commands history.

Instance Method Summary

• #cancel ⇒ Object

  Cancel command.

• #jobs ⇒ Hash

  Hadoop jobs spawned by command.

• #logs ⇒ String

  Fetch command logs.

• #parse(attrs) ⇒ Command

  Update command attributes.

• #refresh! ⇒ Command

  Refresh command attributes.

• #results ⇒ Hash

  Fetch command results.

• #submit(params = {}) ⇒ Command

  Submit command to Qubole.

Class Method Details

.find(id) ⇒ Command

Find command by id

Parameters:

• id (Integer) —

  command id

Returns:

• (Command) —

  command instance

# File 'lib/qubole/command.rb', line 24

def self.find(id)
  command = Qubole.get("/commands/#{id}")
  new(command)
end

.page(page, opts = {}) ⇒ Array<Command>

Paginated commands history

Parameters:

• page (Integer) —

  page number

• opts (Hash) (defaults to: {}) —

  addional options

• attrs (Hash) —

  a customizable set of options

Returns:

• (Array<Command>) —

  paginated commands

# File 'lib/qubole/command.rb', line 12

def self.page(page, opts = {})
  per_page = opts[:per_page] || 10
  Qubole.get('/commands', page: page, per_page: per_page)['commands'].map do |command|
    new(command)
  end
end

Instance Method Details

#cancel ⇒ Object

Cancel command

# File 'lib/qubole/command.rb', line 87

def cancel
  Qubole.put("/commands/#{id}")
end

#jobs ⇒ Hash

Hadoop jobs spawned by command

Returns:

• (Hash) —

  parsed JSON response

# File 'lib/qubole/command.rb', line 80

def jobs
  Qubole.get("/commands/#{id}/jobs")
end

#logs ⇒ String

Fetch command logs

Returns:

• (String) —

  command logs

# File 'lib/qubole/command.rb', line 72

def logs
  Qubole.get("/commands/#{id}/logs")
end

#parse(attrs) ⇒ Command

Update command attributes

Parameters:

• attrs (Hash) —

  command attributes

Returns:

• (Command) —

  command instance

# File 'lib/qubole/command.rb', line 34

def parse(attrs)
  attrs.each do |key, value|
    send("#{key}=", value)
  end
end

#refresh! ⇒ Command

Refresh command attributes

Returns:

• (Command) —

  command instance

# File 'lib/qubole/command.rb', line 55

def refresh!
  command = Qubole.get("/commands/#{id}")
  parse(command)
end

#results ⇒ Hash

Fetch command results

Returns:

• (Hash) —

  parsed JSON response

# File 'lib/qubole/command.rb', line 64

def results
  Qubole.get("/commands/#{id}/results")
end

#submit(params = {}) ⇒ Command

Submit command to Qubole

Parameters:

• params (Hash) (defaults to: {}) —

  command payload

Returns:

• (Command) —

  command instance

# File 'lib/qubole/command.rb', line 45

def submit(params = {})
  parse(params)
  response = Qubole.post('/commands', self.to_h)
  parse(response)
end