Class: Eco::API::Session::Batch

Inherits:
Common::Session::BaseSession show all
Includes:
Launcher, Searcher
Defined in:
lib/eco/api/session/batch.rb,
lib/eco/api/session/batch/job.rb,
lib/eco/api/session/batch/jobs.rb,
lib/eco/api/session/batch/errors.rb,
lib/eco/api/session/batch/status.rb,
lib/eco/api/session/batch/feedback.rb,
lib/eco/api/session/batch/launcher.rb,
lib/eco/api/session/batch/policies.rb,
lib/eco/api/session/batch/searcher.rb,
lib/eco/api/session/batch/base_policy.rb,
lib/eco/api/session/batch/jobs_groups.rb,
lib/eco/api/session/batch/request_stats.rb,
lib/eco/api/session/batch/launcher/retry.rb,
lib/eco/api/session/batch/launcher/options.rb,
lib/eco/api/session/batch/launcher/mode_size.rb,
lib/eco/api/session/batch/launcher/benchmarking.rb,
lib/eco/api/session/batch/launcher/valid_methods.rb,
lib/eco/api/session/batch/launcher/status_handling.rb

Defined Under Namespace

Modules: Launcher, Searcher Classes: BasePolicy, Errors, Feedback, Job, Jobs, JobsGroups, Policies, RequestStats, Status

Constant Summary

Constants included from Launcher

Launcher::RETRY_ON, Launcher::TIMEOUT_RETRIES

Constants included from Launcher::ModeSize

Launcher::ModeSize::DEFAULT_BATCH_SIZE, Launcher::ModeSize::DEFAULT_JOB_SIZE

Instance Attribute Summary

Attributes inherited from Common::Session::BaseSession

#config, #environment, #session

Attributes included from Language::AuxiliarLogger

#logger

Instance Method Summary collapse

Methods included from Searcher

#get_people, #search

Methods included from Launcher::ModeSize

#batch_size

Methods inherited from Common::Session::BaseSession

#api, #api?, #fatal, #file_manager, #initialize, #logger, #mailer, #mailer?, #s3uploader, #s3uploader?, #sftp, #sftp?

Methods included from Language::AuxiliarLogger

#log

Constructor Details

This class inherits a constructor from Eco::API::Common::Session::BaseSession

Instance Method Details

#launch ⇒ Batch::Status

launches a batch of method type using people and the specified params

Parameters:

  • people (People, Enumerable<Person>, Enumerable<Hash>) —

    target People to launch the batch against.

  • method (Symbol) —

    the method to launch the batch api request with.

  • params (Hash) —

    api request options.

Returns:

Raises:

  • Exception

    • if people is nil or is not an Enumerable.
    • if there's no api connection linked to the current Batch.


20
21
22
 
# File 'lib/eco/api/session/batch.rb', line 20

def launch(...)
  batch_from(...)
end