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

Interface CreateAssetModelCompositeModelRequest.Builder

    • Method Detail

      • assetModelId

        CreateAssetModelCompositeModelRequest.Builder assetModelId​(String assetModelId)

        The ID of the asset model this composite model is a part of.

        Parameters:
        assetModelId - The ID of the asset model this composite model is a part of.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelCompositeModelExternalId

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelExternalId​(String assetModelCompositeModelExternalId)

        An external ID to assign to the composite 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:
        assetModelCompositeModelExternalId - An external ID to assign to the composite 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.

      • parentAssetModelCompositeModelId

        CreateAssetModelCompositeModelRequest.Builder parentAssetModelCompositeModelId​(String parentAssetModelCompositeModelId)

        The ID of the parent composite model in this asset model relationship.

        Parameters:
        parentAssetModelCompositeModelId - The ID of the parent composite model in this asset model relationship.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelCompositeModelId

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelId​(String assetModelCompositeModelId)

        The ID of the composite model. 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:
        assetModelCompositeModelId - The ID of the composite model. 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.

      • assetModelCompositeModelDescription

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelDescription​(String assetModelCompositeModelDescription)

        A description for the composite model.

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

      • assetModelCompositeModelName

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelName​(String assetModelCompositeModelName)

        A unique name for the composite model.

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

      • assetModelCompositeModelType

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelType​(String assetModelCompositeModelType)

        The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

        Parameters:
        assetModelCompositeModelType - The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

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

      • composedAssetModelId

        CreateAssetModelCompositeModelRequest.Builder composedAssetModelId​(String composedAssetModelId)

        The ID of a component model which is reused to create this composite model.

        Parameters:
        composedAssetModelId - The ID of a component model which is reused to create this composite model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetModelCompositeModelProperties

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelProperties​(Collection<AssetModelPropertyDefinition> assetModelCompositeModelProperties)

        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

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

        Parameters:
        assetModelCompositeModelProperties - The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

        You can specify up to 200 properties per composite 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.

      • assetModelCompositeModelProperties

        CreateAssetModelCompositeModelRequest.Builder assetModelCompositeModelProperties​(AssetModelPropertyDefinition... assetModelCompositeModelProperties)

        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

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

        Parameters:
        assetModelCompositeModelProperties - The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

        You can specify up to 200 properties per composite 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.

      • ifMatch

        CreateAssetModelCompositeModelRequest.Builder ifMatch​(String ifMatch)

        The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

        Parameters:
        ifMatch - The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ifNoneMatch

        CreateAssetModelCompositeModelRequest.Builder ifNoneMatch​(String ifNoneMatch)

        Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

        Parameters:
        ifNoneMatch - Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matchForVersionType

        CreateAssetModelCompositeModelRequest.Builder matchForVersionType​(String matchForVersionType)

        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

        Parameters:
        matchForVersionType - Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AssetModelVersionType, AssetModelVersionType

      • matchForVersionType

        CreateAssetModelCompositeModelRequest.Builder matchForVersionType​(AssetModelVersionType matchForVersionType)

        Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

        Parameters:
        matchForVersionType - Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AssetModelVersionType, AssetModelVersionType