Actuator (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotfleetwise.model.Actuator

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Actuator
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Actuator()

Constructors
Constructor and Description
`Actuator()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Actuator`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAllowedValues()` A list of possible values an actuator can take.
`String`	`getAssignedValue()` Deprecated.
`String`	`getComment()` A comment in addition to the description.
`String`	`getDataType()` The specified data type of the actuator.
`String`	`getDeprecationMessage()` The deprecation message for the node or the branch that was moved or deleted.
`String`	`getDescription()` A brief description of the actuator.
`String`	`getFullyQualifiedName()` The fully qualified name of the actuator.
`Double`	`getMax()` The specified possible maximum value of an actuator.
`Double`	`getMin()` The specified possible minimum value of an actuator.
`String`	`getStructFullyQualifiedName()` The fully qualified name of the struct node for the actuator if the data type of the actuator is `Struct` or `StructArray`.
`String`	`getUnit()` The scientific unit for the actuator.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowedValues(Collection<String> allowedValues)` A list of possible values an actuator can take.
`void`	`setAssignedValue(String assignedValue)` Deprecated.
`void`	`setComment(String comment)` A comment in addition to the description.
`void`	`setDataType(String dataType)` The specified data type of the actuator.
`void`	`setDeprecationMessage(String deprecationMessage)` The deprecation message for the node or the branch that was moved or deleted.
`void`	`setDescription(String description)` A brief description of the actuator.
`void`	`setFullyQualifiedName(String fullyQualifiedName)` The fully qualified name of the actuator.
`void`	`setMax(Double max)` The specified possible maximum value of an actuator.
`void`	`setMin(Double min)` The specified possible minimum value of an actuator.
`void`	`setStructFullyQualifiedName(String structFullyQualifiedName)` The fully qualified name of the struct node for the actuator if the data type of the actuator is `Struct` or `StructArray`.
`void`	`setUnit(String unit)` The scientific unit for the actuator.
`String`	`toString()` Returns a string representation of this object.
`Actuator`	`withAllowedValues(Collection<String> allowedValues)` A list of possible values an actuator can take.
`Actuator`	`withAllowedValues(String... allowedValues)` A list of possible values an actuator can take.
`Actuator`	`withAssignedValue(String assignedValue)` Deprecated.
`Actuator`	`withComment(String comment)` A comment in addition to the description.
`Actuator`	`withDataType(NodeDataType dataType)` The specified data type of the actuator.
`Actuator`	`withDataType(String dataType)` The specified data type of the actuator.
`Actuator`	`withDeprecationMessage(String deprecationMessage)` The deprecation message for the node or the branch that was moved or deleted.
`Actuator`	`withDescription(String description)` A brief description of the actuator.
`Actuator`	`withFullyQualifiedName(String fullyQualifiedName)` The fully qualified name of the actuator.
`Actuator`	`withMax(Double max)` The specified possible maximum value of an actuator.
`Actuator`	`withMin(Double min)` The specified possible minimum value of an actuator.
`Actuator`	`withStructFullyQualifiedName(String structFullyQualifiedName)` The fully qualified name of the struct node for the actuator if the data type of the actuator is `Struct` or `StructArray`.
`Actuator`	`withUnit(String unit)` The scientific unit for the actuator.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Actuator
```
public Actuator()
```
- Method Detail
  - setFullyQualifiedName
```
public void setFullyQualifiedName(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.
    
    Parameters:
    
    fullyQualifiedName - The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
    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.
  - withFullyQualifiedName
```
public Actuator withFullyQualifiedName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String dataType)
```
    The specified data type of the actuator.
    
    Parameters:
    
    dataType - The specified data type of the actuator.
    
    See Also:
    
    NodeDataType
  - getDataType
```
public String getDataType()
```
    The specified data type of the actuator.
    
    Returns:
    
    The specified data type of the actuator.
    
    See Also:
    
    NodeDataType
  - withDataType
```
public Actuator withDataType(String dataType)
```
    The specified data type of the actuator.
    
    Parameters:
    
    dataType - The specified data type of the actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NodeDataType
  - withDataType
```
public Actuator withDataType(NodeDataType dataType)
```
    The specified data type of the actuator.
    
    Parameters:
    
    dataType - The specified data type of the actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NodeDataType
  - setDescription
```
public void setDescription(String description)
```
    A brief description of the actuator.
    
    Parameters:
    
    description - A brief description of the actuator.
  - getDescription
```
public String getDescription()
```
    A brief description of the actuator.
    
    Returns:
    
    A brief description of the actuator.
  - withDescription
```
public Actuator withDescription(String description)
```
    A brief description of the actuator.
    
    Parameters:
    
    description - A brief description of the actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    The scientific unit for the actuator.
    
    Parameters:
    
    unit - The scientific unit for the actuator.
  - getUnit
```
public String getUnit()
```
    The scientific unit for the actuator.
    
    Returns:
    
    The scientific unit for the actuator.
  - withUnit
```
public Actuator withUnit(String unit)
```
    The scientific unit for the actuator.
    
    Parameters:
    
    unit - The scientific unit for the actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowedValues
```
public List<String> getAllowedValues()
```
    A list of possible values an actuator can take.
    
    Returns:
    
    A list of possible values an actuator can take.
  - setAllowedValues
```
public void setAllowedValues(Collection<String> allowedValues)
```
    A list of possible values an actuator can take.
    
    Parameters:
    
    allowedValues - A list of possible values an actuator can take.
  - withAllowedValues
```
public Actuator withAllowedValues(String... allowedValues)
```
    A list of possible values an actuator can take.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedValues(java.util.Collection) or withAllowedValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowedValues - A list of possible values an actuator can take.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedValues
```
public Actuator withAllowedValues(Collection<String> allowedValues)
```
    A list of possible values an actuator can take.
    
    Parameters:
    
    allowedValues - A list of possible values an actuator can take.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMin
```
public void setMin(Double min)
```
    The specified possible minimum value of an actuator.
    
    Parameters:
    
    min - The specified possible minimum value of an actuator.
  - getMin
```
public Double getMin()
```
    The specified possible minimum value of an actuator.
    
    Returns:
    
    The specified possible minimum value of an actuator.
  - withMin
```
public Actuator withMin(Double min)
```
    The specified possible minimum value of an actuator.
    
    Parameters:
    
    min - The specified possible minimum value of an actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMax
```
public void setMax(Double max)
```
    The specified possible maximum value of an actuator.
    
    Parameters:
    
    max - The specified possible maximum value of an actuator.
  - getMax
```
public Double getMax()
```
    The specified possible maximum value of an actuator.
    
    Returns:
    
    The specified possible maximum value of an actuator.
  - withMax
```
public Actuator withMax(Double max)
```
    The specified possible maximum value of an actuator.
    
    Parameters:
    
    max - The specified possible maximum value of an actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssignedValue
```
@Deprecated
public void setAssignedValue(String assignedValue)
```
    Deprecated.
    
    A specified value for the actuator.
    
    Parameters:
    
    assignedValue - A specified value for the actuator.
  - getAssignedValue
```
@Deprecated
public String getAssignedValue()
```
    Deprecated.
    
    A specified value for the actuator.
    
    Returns:
    
    A specified value for the actuator.
  - withAssignedValue
```
@Deprecated
public Actuator withAssignedValue(String assignedValue)
```
    Deprecated.
    
    A specified value for the actuator.
    
    Parameters:
    
    assignedValue - A specified value for the actuator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeprecationMessage
```
public void setDeprecationMessage(String deprecationMessage)
```
    The deprecation message for the node or the branch that was moved or deleted.
    
    Parameters:
    
    deprecationMessage - The deprecation message for the node or the branch that was moved or deleted.
  - getDeprecationMessage
```
public String getDeprecationMessage()
```
    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.
  - withDeprecationMessage
```
public Actuator withDeprecationMessage(String deprecationMessage)
```
    The deprecation message for the node or the branch that was moved or deleted.
    
    Parameters:
    
    deprecationMessage - The deprecation message for the node or the branch that was moved or deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComment
```
public void setComment(String comment)
```
    A comment in addition to the description.
    
    Parameters:
    
    comment - A comment in addition to the description.
  - getComment
```
public String getComment()
```
    A comment in addition to the description.
    
    Returns:
    
    A comment in addition to the description.
  - withComment
```
public Actuator withComment(String comment)
```
    A comment in addition to the description.
    
    Parameters:
    
    comment - A comment in addition to the description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStructFullyQualifiedName
```
public void setStructFullyQualifiedName(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.
    
    Parameters:
    
    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.
  - getStructFullyQualifiedName
```
public String getStructFullyQualifiedName()
```
    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.
  - withStructFullyQualifiedName
```
public Actuator withStructFullyQualifiedName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Actuator clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class Actuator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Actuator

Method Detail

setFullyQualifiedName

getFullyQualifiedName

withFullyQualifiedName

setDataType

getDataType

withDataType

withDataType

setDescription

getDescription

withDescription

setUnit

getUnit

withUnit

getAllowedValues

setAllowedValues

withAllowedValues

withAllowedValues

setMin

getMin

withMin

setMax

getMax

withMax

setAssignedValue

getAssignedValue

withAssignedValue

setDeprecationMessage

getDeprecationMessage

withDeprecationMessage

setComment

getComment

withComment

setStructFullyQualifiedName

getStructFullyQualifiedName

withStructFullyQualifiedName

toString

equals

hashCode

clone

marshall