com.amazonaws.services.iotfleetwise.model

Class Actuator

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

Method Summary

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	getDataType() The specified data type of the actuator.
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	getUnit() The scientific unit for the actuator.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAllowedValues(Collection<String> allowedValues) A list of possible values an actuator can take.
void	setAssignedValue(String assignedValue) Deprecated.
void	setDataType(String dataType) The specified data type of the actuator.
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	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	withDataType(NodeDataType dataType) The specified data type of the actuator.
Actuator	withDataType(String dataType) The specified data type of the actuator.
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	withUnit(String unit) The scientific unit for the actuator.

Methods inherited from class java.lang.Object

finalize, 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.

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)

Specified by:

marshall in interface StructuredPojo