Package software.amazon.awssdk.services.iotsitewise.model

Interface AssetCompositeModelSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AssetCompositeModelSummary.Builder,AssetCompositeModelSummary>, SdkBuilder<AssetCompositeModelSummary.Builder,AssetCompositeModelSummary>, SdkPojo
Enclosing class:
AssetCompositeModelSummary
public static interface AssetCompositeModelSummary.Builder extends SdkPojo, CopyableBuilder<AssetCompositeModelSummary.Builder,AssetCompositeModelSummary>

  • Method Details

    • id

      AssetCompositeModelSummary.Builder id(String id)

      The ID of the composite model that this summary describes.

      Parameters:
      id - The ID of the composite model that this summary describes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalId

      AssetCompositeModelSummary.Builder externalId(String externalId)

      An external ID to assign to the asset model.

      If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

      Parameters:
      externalId - An external ID to assign to the asset model.

      If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      AssetCompositeModelSummary.Builder name(String name)

      The name of the composite model that this summary describes.

      Parameters:
      name - The name of the composite model that this summary describes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      AssetCompositeModelSummary.Builder type(String type)

      The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

      Parameters:
      type - The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      AssetCompositeModelSummary.Builder description(String description)

      A description of the composite model that this summary describes.

      Parameters:
      description - A description of the composite model that this summary describes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      AssetCompositeModelSummary.Builder path(Collection<AssetCompositeModelPathSegment> path)

      The path that includes all the components of the asset model for the asset.

      Parameters:
      path - The path that includes all the components of the asset model for the asset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      AssetCompositeModelSummary.Builder path(AssetCompositeModelPathSegment... path)

      The path that includes all the components of the asset model for the asset.

      Parameters:
      path - The path that includes all the components of the asset model for the asset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      AssetCompositeModelSummary.Builder path(Consumer<AssetCompositeModelPathSegment.Builder>... path)

      The path that includes all the components of the asset model for the asset.

      This is a convenience method that creates an instance of the AssetCompositeModelPathSegment.Builder avoiding the need to create one manually via AssetCompositeModelPathSegment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to path(List<AssetCompositeModelPathSegment>).

      Parameters:
      path - a consumer that will call methods on AssetCompositeModelPathSegment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: