Class: Aws::Omics::Waiters::ReferenceImportJobCompleted

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-omics/waiters.rb

Overview

Wait until a job is completed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ReferenceImportJobCompleted

Returns a new instance of ReferenceImportJobCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 20
  • :delay (Integer) — default: 30
  • :before_attempt (Proc)
  • :before_wait (Proc)


603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
# File 'lib/aws-sdk-omics/waiters.rb', line 603

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_reference_import_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "COMPLETED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "SUBMITTED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "IN_PROGRESS"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "CANCELLING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "CANCELLED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "COMPLETED_WITH_FAILURES"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



665
666
667
# File 'lib/aws-sdk-omics/waiters.rb', line 665

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::GetReferenceImportJobResponse

Returns a response object which responds to the following methods:

Options Hash (params):

  • :id (required, String)

    The job’s ID.

  • :reference_store_id (required, String)

    The job’s reference store ID.

Returns:



660
661
662
# File 'lib/aws-sdk-omics/waiters.rb', line 660

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end