software.amazon.awssdk.services.iotsitewise.model

Class DescribeAssetModelResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeAssetModelResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAssetModelResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAssetModelResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	assetModelArn() The ARN of the asset model, which has the following format.
List<AssetModelCompositeModel>	assetModelCompositeModels() The list of composite asset models for the asset model.
Instant	assetModelCreationDate() The date the asset model was created, in Unix epoch time.
String	assetModelDescription() The asset model's description.
List<AssetModelHierarchy>	assetModelHierarchies() A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id).
String	assetModelId() The ID of the asset model.
Instant	assetModelLastUpdateDate() The date the asset model was last updated, in Unix epoch time.
String	assetModelName() The name of the asset model.
List<AssetModelProperty>	assetModelProperties() The list of asset properties for the asset model.
AssetModelStatus	assetModelStatus() The current status of the asset model, which contains a state and any error message.
static DescribeAssetModelResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssetModelCompositeModels() For responses, this returns true if the service returned a value for the AssetModelCompositeModels property.
boolean	hasAssetModelHierarchies() For responses, this returns true if the service returned a value for the AssetModelHierarchies property.
boolean	hasAssetModelProperties() For responses, this returns true if the service returned a value for the AssetModelProperties property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAssetModelResponse.Builder>	serializableBuilderClass()
DescribeAssetModelResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

assetModelId

public final String assetModelId()

The ID of the asset model.

Returns:

The ID of the asset model.

assetModelArn

public final String assetModelArn()

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}

assetModelName

public final String assetModelName()

The name of the asset model.

Returns:

The name of the asset model.

assetModelDescription

public final String assetModelDescription()

The asset model's description.

Returns:

The asset model's description.

hasAssetModelProperties

public final boolean hasAssetModelProperties()

For responses, this returns true if the service returned a value for the AssetModelProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

assetModelProperties

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssetModelProperties() method.

Returns:

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.

hasAssetModelHierarchies

public final boolean hasAssetModelHierarchies()

For responses, this returns true if the service returned a value for the AssetModelHierarchies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

assetModelHierarchies

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssetModelHierarchies() method.

Returns:

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.

hasAssetModelCompositeModels

public final boolean hasAssetModelCompositeModels()

For responses, this returns true if the service returned a value for the AssetModelCompositeModels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

assetModelCompositeModels

public final List<AssetModelCompositeModel> assetModelCompositeModels()

The list of composite asset models for the asset model.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssetModelCompositeModels() method.

Returns:

The list of composite asset models for the asset model.

assetModelCreationDate

public final Instant assetModelCreationDate()

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

Returns:

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

assetModelLastUpdateDate

public final Instant assetModelLastUpdateDate()

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.

assetModelStatus

public final AssetModelStatus assetModelStatus()

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

Returns:

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

toBuilder

public DescribeAssetModelResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAssetModelResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAssetModelResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo