Interface DescribeAssetModelResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeAssetModelResponse
@Mutable @NotThreadSafe public static interface DescribeAssetModelResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

  • Method Details

    • assetModelId

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

    • assetModelExternalId

      DescribeAssetModelResponse.Builder assetModelExternalId(String assetModelExternalId)

      The external ID of the asset model, if any.

      Parameters:
      assetModelExternalId - The external ID of the asset model, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelArn

      DescribeAssetModelResponse.Builder assetModelArn(String assetModelArn)

      The ARN of the asset model, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      Parameters:
      assetModelArn - The ARN of the asset model, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

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

    • assetModelName

      DescribeAssetModelResponse.Builder assetModelName(String assetModelName)

      The name of the asset model.

      Parameters:
      assetModelName - The name of the asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelType

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

      DescribeAssetModelResponse.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:

    • assetModelDescription

      DescribeAssetModelResponse.Builder assetModelDescription(String assetModelDescription)

      The asset model's description.

      Parameters:
      assetModelDescription - The asset model's description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelProperties

      DescribeAssetModelResponse.Builder assetModelProperties(Collection<AssetModelProperty> assetModelProperties)

      The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

      Parameters:
      assetModelProperties - The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

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

    • assetModelProperties

      DescribeAssetModelResponse.Builder assetModelProperties(AssetModelProperty... assetModelProperties)

      The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

      Parameters:
      assetModelProperties - The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

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

    • assetModelProperties

      DescribeAssetModelResponse.Builder assetModelProperties(Consumer<AssetModelProperty.Builder>... assetModelProperties)

      The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

      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 assetModelProperties(List<AssetModelProperty>).

      Parameters:
      assetModelProperties - 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:

    • assetModelHierarchies

      DescribeAssetModelResponse.Builder assetModelHierarchies(Collection<AssetModelHierarchy> assetModelHierarchies)

      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

      Parameters:
      assetModelHierarchies - A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelHierarchies

      DescribeAssetModelResponse.Builder assetModelHierarchies(AssetModelHierarchy... assetModelHierarchies)

      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

      Parameters:
      assetModelHierarchies - A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelHierarchies

      DescribeAssetModelResponse.Builder assetModelHierarchies(Consumer<AssetModelHierarchy.Builder>... assetModelHierarchies)

      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

      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<AssetModelHierarchy>).

      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:

    • assetModelCompositeModels

      DescribeAssetModelResponse.Builder assetModelCompositeModels(Collection<AssetModelCompositeModel> assetModelCompositeModels)

      The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

      Parameters:
      assetModelCompositeModels - The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModels

      DescribeAssetModelResponse.Builder assetModelCompositeModels(AssetModelCompositeModel... assetModelCompositeModels)

      The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

      Parameters:
      assetModelCompositeModels - The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModels

      DescribeAssetModelResponse.Builder assetModelCompositeModels(Consumer<AssetModelCompositeModel.Builder>... assetModelCompositeModels)

      The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

      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<AssetModelCompositeModel>).

      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:

    • assetModelCompositeModelSummaries

      DescribeAssetModelResponse.Builder assetModelCompositeModelSummaries(Collection<AssetModelCompositeModelSummary> assetModelCompositeModelSummaries)

      The list of the immediate child custom composite model summaries for the asset model.

      Parameters:
      assetModelCompositeModelSummaries - The list of the immediate child custom composite model summaries for the asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModelSummaries

      DescribeAssetModelResponse.Builder assetModelCompositeModelSummaries(AssetModelCompositeModelSummary... assetModelCompositeModelSummaries)

      The list of the immediate child custom composite model summaries for the asset model.

      Parameters:
      assetModelCompositeModelSummaries - The list of the immediate child custom composite model summaries for the asset model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelCompositeModelSummaries

      DescribeAssetModelResponse.Builder assetModelCompositeModelSummaries(Consumer<AssetModelCompositeModelSummary.Builder>... assetModelCompositeModelSummaries)

      The list of the immediate child custom composite model summaries for the asset model.

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

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

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

    • assetModelCreationDate

      DescribeAssetModelResponse.Builder assetModelCreationDate(Instant assetModelCreationDate)

      The date the asset model was created, in Unix epoch time.

      Parameters:
      assetModelCreationDate - The date the asset model was created, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelLastUpdateDate

      DescribeAssetModelResponse.Builder assetModelLastUpdateDate(Instant assetModelLastUpdateDate)

      The date the asset model was last updated, in Unix epoch time.

      Parameters:
      assetModelLastUpdateDate - The date the asset model was last updated, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelStatus

      DescribeAssetModelResponse.Builder assetModelStatus(AssetModelStatus assetModelStatus)

      The current status of the asset model, which contains a state and any error message.

      Parameters:
      assetModelStatus - The current status of the asset model, which contains a state and any error message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetModelStatus

      default DescribeAssetModelResponse.Builder assetModelStatus(Consumer<AssetModelStatus.Builder> assetModelStatus)

      The current status of the asset model, which contains a state and any error message.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assetModelStatus(AssetModelStatus).

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

    • assetModelVersion

      DescribeAssetModelResponse.Builder assetModelVersion(String assetModelVersion)

      The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.

      Parameters:
      assetModelVersion - The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interfaceDetails

      DescribeAssetModelResponse.Builder interfaceDetails(Collection<InterfaceRelationship> interfaceDetails)

      A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.

      Parameters:
      interfaceDetails - A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interfaceDetails

      DescribeAssetModelResponse.Builder interfaceDetails(InterfaceRelationship... interfaceDetails)

      A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.

      Parameters:
      interfaceDetails - A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interfaceDetails

      DescribeAssetModelResponse.Builder interfaceDetails(Consumer<InterfaceRelationship.Builder>... interfaceDetails)

      A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.

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

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

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

    • eTag

      DescribeAssetModelResponse.Builder eTag(String eTag)

      The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

      See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

      Parameters:
      eTag - The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

      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.