Class AssetModelHierarchy
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetModelHierarchy.Builder,
AssetModelHierarchy>
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AssetModelHierarchy.Builder
builder()
final String
The ID of the asset model, in UUID format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The ID of the asset model hierarchy.final String
name()
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.static Class
<? extends AssetModelHierarchy.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.
- Returns:
- 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.
-
-
-
name
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
- Returns:
- The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
-
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.- Returns:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssetModelHierarchy.Builder,
AssetModelHierarchy> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-