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

Inherits:

Object

Object
Aws::IoTSiteWise::Waiters::AssetModelNotExists

show all

Defined in:: lib/aws-sdk-iotsitewise/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#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 '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 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.



200
201
202

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#asset_model_id => String
#asset_model_external_id => String
#asset_model_arn => String
#asset_model_name => String
#asset_model_type => 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_composite_model_summaries => Array<Types::AssetModelCompositeModelSummary>
#asset_model_creation_date => Time
#asset_model_last_update_date => Time
#asset_model_status => Types::AssetModelStatus
#asset_model_version => String
#e_tag => String

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*.

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

Whether or not to exclude asset model properties from the response.
:asset_model_version (String) —

The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is ‘LATEST`. See [ Asset model versions] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html

Returns:

(Types::DescribeAssetModelResponse) —
Returns a response object which responds to the following methods:
- #asset_model_id => String
- #asset_model_external_id => String
- #asset_model_arn => String
- #asset_model_name => String
- #asset_model_type => 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_composite_model_summaries => Array<Types::AssetModelCompositeModelSummary>
- #asset_model_creation_date => Time
- #asset_model_last_update_date => Time
- #asset_model_status => Types::AssetModelStatus
- #asset_model_version => String
- #e_tag => String



195
196
197

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

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