Package software.amazon.awssdk.services.iotsitewise.model

Class VariableValue

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.VariableValue

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VariableValue.Builder,VariableValue>

@Generated("software.amazon.awssdk:codegen")
public final class VariableValue
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VariableValue.Builder,VariableValue>

Identifies a property value used in an expression.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VariableValue.Builder

Method Summary

Modifier and Type	Method	Description
static VariableValue.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPropertyPath()	For responses, this returns true if the service returned a value for the PropertyPath property.
String	hierarchyId()	The ID of the hierarchy to query for the property ID.
String	propertyId()	The ID of the property to use as the variable.
List<AssetModelPropertyPathSegment>	propertyPath()	The path of the property.
List<SdkField<?>>	sdkFields()
static Class<? extends VariableValue.Builder>	serializableBuilderClass()
VariableValue.Builder	toBuilder()
String	toString()	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

propertyId

public final String propertyId()

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

hierarchyId

public final String hierarchyId()

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

Returns:

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

hasPropertyPath

public final boolean hasPropertyPath()

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

propertyPath

public final List<AssetModelPropertyPathSegment> propertyPath()

The path of the property.

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

Returns:

The path of the property.

toBuilder

public VariableValue.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VariableValue.Builder,VariableValue>

builder

public static VariableValue.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo