Interface UpdateAssetModelCompositeModelRequest.Builder

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

  • Method Details

    • assetModelId

      UpdateAssetModelCompositeModelRequest.Builder assetModelId(String assetModelId)

      The ID of the asset model, in UUID format.

      Parameters:
      assetModelId - The ID of the asset model, in UUID format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModelId

      UpdateAssetModelCompositeModelRequest.Builder assetModelCompositeModelId(String assetModelCompositeModelId)

      The ID of a composite model on this asset model.

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

    • assetModelCompositeModelExternalId

      UpdateAssetModelCompositeModelRequest.Builder assetModelCompositeModelExternalId(String assetModelCompositeModelExternalId)

      An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.

      Parameters:
      assetModelCompositeModelExternalId - An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModelDescription

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

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

    • clientToken

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

    • assetModelCompositeModelProperties

      UpdateAssetModelCompositeModelRequest.Builder assetModelCompositeModelProperties(Collection<AssetModelProperty> 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

      UpdateAssetModelCompositeModelRequest.Builder assetModelCompositeModelProperties(AssetModelProperty... 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

      UpdateAssetModelCompositeModelRequest.Builder assetModelCompositeModelProperties(Consumer<AssetModelProperty.Builder>... 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.

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

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

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

    • ifMatch

      UpdateAssetModelCompositeModelRequest.Builder ifMatch(String ifMatch)

      The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update 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 update 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

      UpdateAssetModelCompositeModelRequest.Builder ifNoneMatch(String ifNoneMatch)

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

      Parameters:
      ifNoneMatch - Accepts * to reject the update 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

      UpdateAssetModelCompositeModelRequest.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 update 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 update operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matchForVersionType

      UpdateAssetModelCompositeModelRequest.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 update 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 update operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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