Class AssetModelSummary
- java.lang.Object
-
- software.amazon.awssdk.services.iotsitewise.model.AssetModelSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AssetModelSummary.Builder,AssetModelSummary>
@Generated("software.amazon.awssdk:codegen") public final class AssetModelSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AssetModelSummary.Builder,AssetModelSummary>
Contains a summary of an asset model.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAssetModelSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of the asset model, which has the following format.AssetModelTypeassetModelType()The type of asset model.StringassetModelTypeAsString()The type of asset model.static AssetModelSummary.Builderbuilder()InstantcreationDate()The date the asset model was created, in Unix epoch time.Stringdescription()The asset model description.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalId()The external ID of the asset model.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The ID of the asset model (used with IoT SiteWise API operations).InstantlastUpdateDate()The date the asset model was last updated, in Unix epoch time.Stringname()The name of the asset model.List<SdkField<?>>sdkFields()static Class<? extends AssetModelSummary.Builder>serializableBuilderClass()AssetModelStatusstatus()The current status of the asset model.AssetModelSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final String id()
The ID of the asset model (used with IoT SiteWise API operations).
- Returns:
- The ID of the asset model (used with IoT SiteWise API operations).
-
arn
public final String arn()
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}- Returns:
- The ARN of the
asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
-
name
public final String name()
The name of the asset model.
- Returns:
- The name of the asset model.
-
description
public final String description()
The asset model description.
- Returns:
- The asset model description.
-
creationDate
public final Instant creationDate()
The date the asset model was created, in Unix epoch time.
- Returns:
- The date the asset model was created, in Unix epoch time.
-
lastUpdateDate
public final Instant lastUpdateDate()
The date the asset model was last updated, in Unix epoch time.
- Returns:
- The date the asset model was last updated, in Unix epoch time.
-
status
public final AssetModelStatus status()
The current status of the asset model.
- Returns:
- The current status of the asset model.
-
assetModelType
public final 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.
If the service returns an enum value that is not available in the current SDK version,
assetModelTypewill returnAssetModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassetModelTypeAsString().- Returns:
- 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.
-
- See Also:
AssetModelType
-
-
assetModelTypeAsString
public final String assetModelTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
assetModelTypewill returnAssetModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassetModelTypeAsString().- Returns:
- 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.
-
- See Also:
AssetModelType
-
-
externalId
public final String externalId()
The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Returns:
- The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
-
toBuilder
public AssetModelSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AssetModelSummary.Builder,AssetModelSummary>
-
builder
public static AssetModelSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends AssetModelSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-