java.lang.Object
- software.amazon.awssdk.services.iotfleetwise.model.SignalDecoder

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SignalDecoder.Builder,SignalDecoder>

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

Information about a signal decoder.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SignalDecoder.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SignalDecoder.Builder`	`builder()`
`CanSignal`	`canSignal()`	Information about signal decoder using the Controller Area Network (CAN) protocol.
`CustomDecodingSignal`	`customDecodingSignal()`	Information about a custom signal decoder.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fullyQualifiedName()`	The fully qualified name of a signal decoder as defined in a vehicle model.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`interfaceId()`	The ID of a network interface that specifies what network protocol a vehicle follows.
`MessageSignal`	`messageSignal()`	The decoding information for a specific message which supports higher order data types.
`ObdSignal`	`obdSignal()`	Information about signal decoder using the on-board diagnostic (OBD) II protocol.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SignalDecoder.Builder>`	`serializableBuilderClass()`
`SignalDecoder.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`SignalDecoderType`	`type()`	The network protocol for the vehicle.
`String`	`typeAsString()`	The network protocol for the vehicle.

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 a signal decoder as defined in a vehicle model.
    
    Returns:
    
    The fully qualified name of a signal decoder as defined in a vehicle model.
  - type
```
public final SignalDecoderType type()
```
    The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SignalDecoderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
    
    See Also:
    
    SignalDecoderType
  - typeAsString
```
public final String typeAsString()
```
    The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SignalDecoderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
    
    See Also:
    
    SignalDecoderType
  - interfaceId
```
public final String interfaceId()
```
    The ID of a network interface that specifies what network protocol a vehicle follows.
    
    Returns:
    
    The ID of a network interface that specifies what network protocol a vehicle follows.
  - canSignal
```
public final CanSignal canSignal()
```
    Information about signal decoder using the Controller Area Network (CAN) protocol.
    
    Returns:
    
    Information about signal decoder using the Controller Area Network (CAN) protocol.
  - obdSignal
```
public final ObdSignal obdSignal()
```
    Information about signal decoder using the on-board diagnostic (OBD) II protocol.
    
    Returns:
    
    Information about signal decoder using the on-board diagnostic (OBD) II protocol.
  - messageSignal
```
public final MessageSignal messageSignal()
```
    The decoding information for a specific message which supports higher order data types.
    
    Returns:
    
    The decoding information for a specific message which supports higher order data types.
  - customDecodingSignal
```
public final CustomDecodingSignal customDecodingSignal()
```
    Information about a custom signal decoder.
    
    Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
    
    Returns:
    
    Information about a custom signal decoder.
    
    Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.
  - toBuilder
```
public SignalDecoder.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SignalDecoder.Builder,SignalDecoder>
  - builder
```
public static SignalDecoder.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SignalDecoder.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SignalDecoder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fullyQualifiedName

type

typeAsString

interfaceId

canSignal

obdSignal

messageSignal

customDecodingSignal

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField