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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasAssetModelCompositeModels() Returns true if the AssetModelCompositeModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAssetModelHierarchies() Returns true if the AssetModelHierarchies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAssetModelProperties() Returns true if the AssetModelProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAssetModelResponse.Builder>	serializableBuilderClass()
DescribeAssetModelResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the AssetModelProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAssetModelProperties() to see if a value was sent in this field.

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()

Returns true if the AssetModelHierarchies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAssetModelHierarchies() to see if a value was sent in this field.

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()

Returns true if the AssetModelCompositeModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAssetModelCompositeModels() to see if a value was sent in this field.

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()

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 interface ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.