software.amazon.awssdk.services.iotsitewise.model

Class CreateAssetModelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.CreateAssetModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAssetModelRequest.Builder,CreateAssetModelRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAssetModelRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AssetModelCompositeModelDefinition>	assetModelCompositeModels() The composite asset models that are part of this asset model.
String	assetModelDescription() A description for the asset model.
List<AssetModelHierarchyDefinition>	assetModelHierarchies() The hierarchy definitions of the asset model.
String	assetModelName() A unique, friendly name for the asset model.
List<AssetModelPropertyDefinition>	assetModelProperties() The property definitions of the asset model.
static CreateAssetModelRequest.Builder	builder()
String	clientToken() A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAssetModelRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A list of key-value pairs that contain metadata for the asset model.
CreateAssetModelRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

assetModelName

public final String assetModelName()

A unique, friendly name for the asset model.

Returns:

A unique, friendly name for the asset model.

assetModelDescription

public final String assetModelDescription()

A description for the asset model.

Returns:

A description for the asset model.

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

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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 property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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:

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this 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 composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

clientToken

public final String clientToken()

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

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 hasTags() method.

Returns:

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

toBuilder

public CreateAssetModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAssetModelRequest.Builder,CreateAssetModelRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static CreateAssetModelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo