Class Sensor
- java.lang.Object
-
- software.amazon.awssdk.services.iotfleetwise.model.Sensor
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Sensor.Builder,Sensor>
@Generated("software.amazon.awssdk:codegen") public final class Sensor extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Sensor.Builder,Sensor>
An input component that reports the environmental condition of a vehicle.
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSensor.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedValues()A list of possible values a sensor can take.static Sensor.Builderbuilder()Stringcomment()A comment in addition to the description.NodeDataTypedataType()The specified data type of the sensor.StringdataTypeAsString()The specified data type of the sensor.StringdeprecationMessage()The deprecation message for the node or the branch that was moved or deleted.Stringdescription()A brief description of a sensor.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfullyQualifiedName()The fully qualified name of the sensor.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedValues()For responses, this returns true if the service returned a value for the AllowedValues property.inthashCode()Doublemax()The specified possible maximum value of the sensor.Doublemin()The specified possible minimum value of the sensor.List<SdkField<?>>sdkFields()static Class<? extends Sensor.Builder>serializableBuilderClass()StringstructFullyQualifiedName()The fully qualified name of the struct node for a sensor if the data type of the actuator isStructorStructArray.Sensor.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringunit()The scientific unit of measurement for data collected by the sensor.-
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 sensor. For example, the fully qualified name of a sensor might be
Vehicle.Body.Engine.Battery.- Returns:
- The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be
Vehicle.Body.Engine.Battery.
-
dataType
public final NodeDataType dataType()
The specified data type of the sensor.
If the service returns an enum value that is not available in the current SDK version,
dataTypewill returnNodeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataTypeAsString().- Returns:
- The specified data type of the sensor.
- See Also:
NodeDataType
-
dataTypeAsString
public final String dataTypeAsString()
The specified data type of the sensor.
If the service returns an enum value that is not available in the current SDK version,
dataTypewill returnNodeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataTypeAsString().- Returns:
- The specified data type of the sensor.
- See Also:
NodeDataType
-
description
public final String description()
A brief description of a sensor.
- Returns:
- A brief description of a sensor.
-
unit
public final String unit()
The scientific unit of measurement for data collected by the sensor.
- Returns:
- The scientific unit of measurement for data collected by the sensor.
-
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 theisEmpty()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 a sensor 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 a sensor can take.
-
min
public final Double min()
The specified possible minimum value of the sensor.
- Returns:
- The specified possible minimum value of the sensor.
-
max
public final Double max()
The specified possible maximum value of the sensor.
- Returns:
- The specified possible maximum value of the sensor.
-
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 a sensor if the data type of the actuator is
StructorStructArray. For example, the struct fully qualified name of a sensor might beVehicle.ADAS.CameraStruct.- Returns:
- The fully qualified name of the struct node for a sensor if the data type of the actuator is
StructorStructArray. For example, the struct fully qualified name of a sensor might beVehicle.ADAS.CameraStruct.
-
toBuilder
public Sensor.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Sensor.Builder,Sensor>
-
builder
public static Sensor.Builder builder()
-
serializableBuilderClass
public static Class<? extends Sensor.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-