Class: Aws::IoTSiteWise::Waiters::AssetActive

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AssetActive

Returns a new instance of AssetActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 89

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_asset,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "asset_status.state",
          "expected" => "ACTIVE"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "asset_status.state",
          "expected" => "FAILED"
        }
      ]
    )
  }.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. 



121
122
123
 
# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 121

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else ‘externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs] in the *IoT SiteWise User Guide*.

    [1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

  • :exclude_properties (Boolean) —

    Whether or not to exclude asset properties from the response.

Returns:



116
117
118
 
# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 116

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