Class: Aws::IoTSiteWise::Waiters::AssetModelNotExists

Inherits:

Object

• Object
• Aws::IoTSiteWise::Waiters::AssetModelNotExists

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ AssetModelNotExists constructor

  A new instance of AssetModelNotExists.

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

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

Constructor Details

#initialize(options) ⇒ AssetModelNotExists

Returns a new instance of AssetModelNotExists.

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 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/waiters.rb', line 177

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_model,
      acceptors: [{
        "state" => "success",
        "matcher" => "error",
        "expected" => "ResourceNotFoundException"
      }]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #asset_model_id => String
• #asset_model_arn => String
• #asset_model_name => String
• #asset_model_description => String
• #asset_model_properties => Array<Types::AssetModelProperty>
• #asset_model_hierarchies => Array<Types::AssetModelHierarchy>
• #asset_model_composite_models => Array<Types::AssetModelCompositeModel>
• #asset_model_creation_date => Time
• #asset_model_last_update_date => Time
• #asset_model_status => Types::AssetModelStatus
• #asset_model_type => String
• #asset_model_composite_model_summaries => Array<Types::AssetModelCompositeModelSummary>
• #asset_model_external_id => String

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :asset_model_id (required, String) —

  The ID of the asset model. 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.

• :exclude_properties (Boolean) —

  Whether or not to exclude asset model properties from the response.

Returns:

• (Types::DescribeAssetModelResponse) —

  Returns a response object which responds to the following methods:

  • #asset_model_id => String
  • #asset_model_arn => String
  • #asset_model_name => String
  • #asset_model_description => String
  • #asset_model_properties => Array<Types::AssetModelProperty>
  • #asset_model_hierarchies => Array<Types::AssetModelHierarchy>
  • #asset_model_composite_models => Array<Types::AssetModelCompositeModel>
  • #asset_model_creation_date => Time
  • #asset_model_last_update_date => Time
  • #asset_model_status => Types::AssetModelStatus
  • #asset_model_type => String
  • #asset_model_composite_model_summaries => Array<Types::AssetModelCompositeModelSummary>
  • #asset_model_external_id => String

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

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