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

Interface UpdateAssetModelRequest.Builder

    • Method Detail

      • assetModelId

        UpdateAssetModelRequest.Builder assetModelId​(String assetModelId)

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

        Parameters:
        assetModelId - The ID of the asset model to update. 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:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelName

        UpdateAssetModelRequest.Builder assetModelName​(String assetModelName)

        A unique, friendly name for the asset model.

        Parameters:
        assetModelName - A unique, friendly name for the asset model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelDescription

        UpdateAssetModelRequest.Builder assetModelDescription​(String assetModelDescription)

        A description for the asset model.

        Parameters:
        assetModelDescription - A description for the asset model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelProperties

        UpdateAssetModelRequest.Builder assetModelProperties​(Collection<AssetModelProperty> assetModelProperties)

        The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        Parameters:
        assetModelProperties - The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

      • assetModelProperties

        UpdateAssetModelRequest.Builder assetModelProperties​(AssetModelProperty... assetModelProperties)

        The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        Parameters:
        assetModelProperties - The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

      • assetModelHierarchies

        UpdateAssetModelRequest.Builder assetModelHierarchies​(Collection<AssetModelHierarchy> assetModelHierarchies)

        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        Parameters:
        assetModelHierarchies - The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

      • assetModelHierarchies

        UpdateAssetModelRequest.Builder assetModelHierarchies​(AssetModelHierarchy... assetModelHierarchies)

        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        Parameters:
        assetModelHierarchies - The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

      • assetModelHierarchies

        UpdateAssetModelRequest.Builder assetModelHierarchies​(Consumer<AssetModelHierarchy.Builder>... assetModelHierarchies)

        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #assetModelHierarchies(List).

        Parameters:
        assetModelHierarchies - a consumer that will call methods on AssetModelHierarchy.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #assetModelHierarchies(java.util.Collection)

      • assetModelCompositeModels

        UpdateAssetModelRequest.Builder assetModelCompositeModels​(Collection<AssetModelCompositeModel> assetModelCompositeModels)

        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

        Parameters:
        assetModelCompositeModels - The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

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

      • assetModelCompositeModels

        UpdateAssetModelRequest.Builder assetModelCompositeModels​(AssetModelCompositeModel... assetModelCompositeModels)

        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

        Parameters:
        assetModelCompositeModels - The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

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

      • assetModelCompositeModels

        UpdateAssetModelRequest.Builder assetModelCompositeModels​(Consumer<AssetModelCompositeModel.Builder>... assetModelCompositeModels)

        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #assetModelCompositeModels(List).

        Parameters:
        assetModelCompositeModels - a consumer that will call methods on AssetModelCompositeModel.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #assetModelCompositeModels(java.util.Collection)

      • clientToken

        UpdateAssetModelRequest.Builder clientToken​(String clientToken)

        A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

        Parameters:
        clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelExternalId

        UpdateAssetModelRequest.Builder assetModelExternalId​(String assetModelExternalId)

        An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

        Parameters:
        assetModelExternalId - An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.