Class: Aws::IoTSiteWise::Types::ListAssetRelationshipsRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ 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.

Returns:

  • (String) 


7111
7112
7113
7114
7115
7116
7117
7118
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7111

class ListAssetRelationshipsRequest < Struct.new(
  :asset_id,
  :traversal_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return for each paginated request.

Returns:

  • (Integer) 


7111
7112
7113
7114
7115
7116
7117
7118
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7111

class ListAssetRelationshipsRequest < Struct.new(
  :asset_id,
  :traversal_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results.

Returns:

  • (String) 


7111
7112
7113
7114
7115
7116
7117
7118
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7111

class ListAssetRelationshipsRequest < Struct.new(
  :asset_id,
  :traversal_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#traversal_type ⇒ String

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

^

Returns:

  • (String) 


7111
7112
7113
7114
7115
7116
7117
7118
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7111

class ListAssetRelationshipsRequest < Struct.new(
  :asset_id,
  :traversal_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end