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

Interface CreateAssetModelRequest.Builder

    • Method Detail

      • assetModelName

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

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

        CreateAssetModelRequest.Builder assetModelProperties​(Collection<AssetModelPropertyDefinition> assetModelProperties)

        The 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 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

        CreateAssetModelRequest.Builder assetModelProperties​(AssetModelPropertyDefinition... assetModelProperties)

        The 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 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

        CreateAssetModelRequest.Builder assetModelHierarchies​(Collection<AssetModelHierarchyDefinition> assetModelHierarchies)

        The 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 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

        CreateAssetModelRequest.Builder assetModelHierarchies​(AssetModelHierarchyDefinition... assetModelHierarchies)

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

      • assetModelCompositeModels

        CreateAssetModelRequest.Builder assetModelCompositeModels​(Collection<AssetModelCompositeModelDefinition> 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

        CreateAssetModelRequest.Builder assetModelCompositeModels​(AssetModelCompositeModelDefinition... 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.

      • clientToken

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

      • assetModelId

        CreateAssetModelRequest.Builder assetModelId​(String assetModelId)

        The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

        Parameters:
        assetModelId - The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelExternalId

        CreateAssetModelRequest.Builder assetModelExternalId​(String assetModelExternalId)

        An external ID to assign to the asset model. 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 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.

      • assetModelType

        CreateAssetModelRequest.Builder assetModelType​(String assetModelType)

        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:
        assetModelType - 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.
        See Also:
        AssetModelType, AssetModelType

      • assetModelType

        CreateAssetModelRequest.Builder assetModelType​(AssetModelType assetModelType)

        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:
        assetModelType - 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.
        See Also:
        AssetModelType, AssetModelType