Interface AssetModelHierarchy.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssetModelHierarchy.Builder,
,AssetModelHierarchy> SdkBuilder<AssetModelHierarchy.Builder,
,AssetModelHierarchy> SdkPojo
- Enclosing class:
AssetModelHierarchy
-
Method Summary
Modifier and TypeMethodDescriptionchildAssetModelId
(String childAssetModelId) The ID of the asset model, in UUID format.externalId
(String externalId) The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.The ID of the asset model hierarchy.The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
id
The ID of the asset model hierarchy. This ID is a
hierarchyId
.-
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing 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:
id
- The ID of the asset model hierarchy. This ID is ahierarchyId
.-
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing 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.
-
-
name
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
- Parameters:
name
- The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childAssetModelId
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the
childAssetModelId
asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or elseexternalId:
followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.- Parameters:
childAssetModelId
- The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of thechildAssetModelId
asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or elseexternalId:
followed by the asset model's external ID. 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.
-
externalId
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Parameters:
externalId
- The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. 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.
-