Class AssetModelCompositeModelDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetModelCompositeModelDefinition.Builder,
AssetModelCompositeModelDefinition>
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The description of the composite model.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
An external ID to assign to the composite model.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Properties property.final String
id()
The ID to assign to the composite model, if desired.final String
name()
The name of the composite model.final List
<AssetModelPropertyDefinition> The asset property definitions for this composite model.static Class
<? extends AssetModelCompositeModelDefinition.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.final String
type()
The type of the composite model.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the composite model.
- Returns:
- The name of the composite model.
-
description
The description of the composite model.
- Returns:
- The description of the composite model.
-
type
The type of the composite model. For alarm composite models, this type is
AWS/ALARM
.- Returns:
- The type of the composite model. For alarm composite models, this type is
AWS/ALARM
.
-
hasProperties
public final boolean hasProperties()For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
properties
The asset property definitions for this composite 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
hasProperties()
method.- Returns:
- The asset property definitions for this composite model.
-
id
The ID to assign to the composite model, 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.
- Returns:
- The ID to assign to the composite model, 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.
-
externalId
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- Returns:
- An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. 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<AssetModelCompositeModelDefinition.Builder,
AssetModelCompositeModelDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AssetModelCompositeModelDefinition.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
-