Class: Aws::IoTSiteWise::Waiters::AssetNotExists

Inherits:

Object

• Object
• Aws::IoTSiteWise::Waiters::AssetNotExists

Defined in:

lib/aws-sdk-iotsitewise/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ AssetNotExists constructor

  A new instance of AssetNotExists.

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

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

Constructor Details

#initialize(options) ⇒ AssetNotExists

Returns a new instance of AssetNotExists.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 212

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" => "error",
        "expected" => "ResourceNotFoundException"
      }]
    )
  }.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-iotsitewise/waiters.rb', line 235

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #asset_id => String

• #asset_arn => String

• #asset_name => String

• #asset_model_id => String

• #asset_properties => Array<Types::AssetProperty>

• #asset_hierarchies => Array<Types::AssetHierarchy>

• #asset_composite_models => Array<Types::AssetCompositeModel>

• #asset_creation_date => Time

• #asset_last_update_date => Time

• #asset_status => Types::AssetStatus

• #asset_description => String

• #asset_composite_model_summaries => Array<Types::AssetCompositeModelSummary>

• #asset_external_id => String

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:

• (Types::DescribeAssetResponse) —

  Returns a response object which responds to the following methods:

  • #asset_id => String

  • #asset_arn => String

  • #asset_name => String

  • #asset_model_id => String

  • #asset_properties => Array<Types::AssetProperty>

  • #asset_hierarchies => Array<Types::AssetHierarchy>

  • #asset_composite_models => Array<Types::AssetCompositeModel>

  • #asset_creation_date => Time

  • #asset_last_update_date => Time

  • #asset_status => Types::AssetStatus

  • #asset_description => String

  • #asset_composite_model_summaries => Array<Types::AssetCompositeModelSummary>

  • #asset_external_id => String

# File 'lib/aws-sdk-iotsitewise/waiters.rb', line 230

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