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

Interface CreateAssetModelCompositeModelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAssetModelCompositeModelRequest
public static interface CreateAssetModelCompositeModelRequest.Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>

  • Method Details

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

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

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

    • 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, friendly name for the composite model.

      Parameters:
      assetModelCompositeModelName - A unique, friendly 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 composite model on this asset.

      Parameters:
      composedAssetModelId - The ID of a composite model on this asset.
      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 <LINK>.

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

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

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

      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(Consumer<AssetModelPropertyDefinition.Builder>... assetModelCompositeModelProperties)

      The property definitions of the composite model. For more information, see <LINK>.

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

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

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

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

    • overrideConfiguration

      CreateAssetModelCompositeModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAssetModelCompositeModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.