Interface AssetModelHierarchyDefinition.Builder

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

  • Method Details

    • id

      AssetModelHierarchyDefinition.Builder id(String id)

      The ID to assign to the asset model hierarchy, 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:
      id - The ID to assign to the asset model hierarchy, 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.

    • externalId

      AssetModelHierarchyDefinition.Builder externalId(String externalId)

      An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

      Parameters:
      externalId - An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. 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.

    • name

      AssetModelHierarchyDefinition.Builder name(String name)

      The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

      Parameters:
      name - The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • childAssetModelId

      AssetModelHierarchyDefinition.Builder childAssetModelId(String childAssetModelId)

      The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

      Parameters:
      childAssetModelId - The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.