Class Actuator

java.lang.Object
software.amazon.awssdk.services.iotfleetwise.model.Actuator
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Actuator.Builder,Actuator>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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

      @Deprecated public final String assignedValue()
      Deprecated.
      assignedValue is no longer in use

      A specified value for the actuator.

      Returns:
      A specified value for the actuator.

    • deprecationMessage

      public final String deprecationMessage()

      The deprecation message for the node or the branch that was moved or deleted.

      Returns:
      The deprecation message for the node or the branch that was moved or deleted.

    • comment

      public final String comment()

      A comment in addition to the description.

      Returns:
      A comment in addition to the description.

    • structFullyQualifiedName

      public final String structFullyQualifiedName()

      The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

      Returns:
      The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

    • toBuilder

      public Actuator.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<Actuator.Builder,Actuator>
      Returns:
      a builder for type T

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

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.