module BarbequeClient
Constants
- VERSION
Public Class Methods
client()
click to toggle source
# File lib/barbeque_client.rb, line 45 def client @client ||= Client.new( application: config.application, default_queue: config.default_queue, endpoint: config.endpoint, tracing: config.tracing, headers: config.headers, ) end
config()
click to toggle source
# File lib/barbeque_client.rb, line 19 def config @config ||= Configuration.new end
configure() { |config| ... }
click to toggle source
# File lib/barbeque_client.rb, line 15 def configure yield config end
enqueue(job:, message:, queue: nil, delay_seconds: nil)
click to toggle source
@param [String] job - Job name to enqueue. @param [Object] message - An object which is serializable as JSON. @param optional [String] queue - A queue name to enqueue a job. @param optional [Integer] delay_seconds - Message timer of SQS. @return [Hashie::Mash] resonse - { message_id: String, status: String }
# File lib/barbeque_client.rb, line 28 def enqueue(job:, message:, queue: nil, delay_seconds: nil) response = client.create_execution( job: job, message: message, queue: queue, delay_seconds: delay_seconds, ) response.body end
status(message_id:)
click to toggle source
@param [String] message_id - Job execution's message_id to check status @return [String] status - Job execution's status like “success”, “pending”, “failure”, …
# File lib/barbeque_client.rb, line 40 def status(message_id:) response = client.execution(message_id: message_id) response.body.status end