Class: Aws::NeptuneGraph::Waiters::GraphSnapshotAvailable

Inherits:

Object

• Object
• Aws::NeptuneGraph::Waiters::GraphSnapshotAvailable

Defined in:

lib/aws-sdk-neptunegraph/waiters.rb

Overview

Wait until GraphSnapshot is Available

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ GraphSnapshotAvailable constructor

  A new instance of GraphSnapshotAvailable.

• #wait(params = {}) ⇒ Types::GetGraphSnapshotOutput

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ GraphSnapshotAvailable

Returns a new instance of GraphSnapshotAvailable.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-neptunegraph/waiters.rb', line 292

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_graph_snapshot,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "DELETING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "AVAILABLE"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (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.

# File 'lib/aws-sdk-neptunegraph/waiters.rb', line 330

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #id => String

• #name => String

• #arn => String

• #source_graph_id => String

• #snapshot_create_time => Time

• #status => String

• #kms_key_identifier => String

Options Hash (params):

• :snapshot_identifier (required, String) —

  The ID of the snapshot to retrieve.

Returns:

• (Types::GetGraphSnapshotOutput) —

  Returns a response object which responds to the following methods:

  • #id => String

  • #name => String

  • #arn => String

  • #source_graph_id => String

  • #snapshot_create_time => Time

  • #status => String

  • #kms_key_identifier => String

# File 'lib/aws-sdk-neptunegraph/waiters.rb', line 325

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