software.amazon.awssdk.services.iotfleetwise.model

Class Actuator

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.Actuator

All Implemented Interfaces:

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

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

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Actuator.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	allowedValues() A list of possible values an actuator can take.
String	assignedValue() A specified value for the actuator.
static Actuator.Builder	builder()
NodeDataType	dataType() The specified data type of the actuator.
String	dataTypeAsString() The specified data type of the actuator.
String	description() A brief description of the actuator.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fullyQualifiedName() The fully qualified name of the actuator.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedValues() For responses, this returns true if the service returned a value for the AllowedValues property.
int	hashCode()
Double	max() The specified possible maximum value of an actuator.
Double	min() The specified possible minimum value of an actuator.
List<SdkField<?>>	sdkFields()
static Class<? extends Actuator.Builder>	serializableBuilderClass()
Actuator.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	unit() The scientific unit for the actuator.

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

fullyQualifiedName

public final String fullyQualifiedName()

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

Returns:

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

dataType

public final NodeDataType dataType()

The specified data type of the actuator.

If the service returns an enum value that is not available in the current SDK version, dataType will return NodeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

The specified data type of the actuator.

See Also:

NodeDataType

dataTypeAsString

public final String dataTypeAsString()

The specified data type of the actuator.

If the service returns an enum value that is not available in the current SDK version, dataType will return NodeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

The specified data type of the actuator.

See Also:

NodeDataType

description

public final String description()

A brief description of the actuator.

Returns:

A brief description of the actuator.

unit

public final String unit()

The scientific unit for the actuator.

Returns:

The scientific unit for the actuator.

hasAllowedValues

public final boolean hasAllowedValues()

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

allowedValues

public final List<String> allowedValues()

A list of possible values an actuator can take.

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

Returns:

A list of possible values an actuator can take.

min

public final Double min()

The specified possible minimum value of an actuator.

Returns:

The specified possible minimum value of an actuator.

max

public final Double max()

The specified possible maximum value of an actuator.

Returns:

The specified possible maximum value of an actuator.

assignedValue

public final String assignedValue()

A specified value for the actuator.

Returns:

A specified value for the actuator.

toBuilder

public Actuator.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Actuator.Builder,Actuator>

builder

public static Actuator.Builder builder()

serializableBuilderClass

public static Class<? extends Actuator.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