Package software.amazon.awssdk.services.iotfleetwise.model

Interface SignalDecoder.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SignalDecoder.Builder,SignalDecoder>, SdkBuilder<SignalDecoder.Builder,SignalDecoder>, SdkPojo

Enclosing class:

SignalDecoder

public static interface SignalDecoder.Builder
extends SdkPojo, CopyableBuilder<SignalDecoder.Builder,SignalDecoder>

Method Summary

Modifier and Type	Method	Description
default SignalDecoder.Builder	canSignal(Consumer<CanSignal.Builder> canSignal)	Information about signal decoder using the Controller Area Network (CAN) protocol.
SignalDecoder.Builder	canSignal(CanSignal canSignal)	Information about signal decoder using the Controller Area Network (CAN) protocol.
default SignalDecoder.Builder	customDecodingSignal(Consumer<CustomDecodingSignal.Builder> customDecodingSignal)	Information about a custom signal decoder.
SignalDecoder.Builder	customDecodingSignal(CustomDecodingSignal customDecodingSignal)	Information about a custom signal decoder.
SignalDecoder.Builder	fullyQualifiedName(String fullyQualifiedName)	The fully qualified name of a signal decoder as defined in a vehicle model.
SignalDecoder.Builder	interfaceId(String interfaceId)	The ID of a network interface that specifies what network protocol a vehicle follows.
default SignalDecoder.Builder	messageSignal(Consumer<MessageSignal.Builder> messageSignal)	The decoding information for a specific message which supports higher order data types.
SignalDecoder.Builder	messageSignal(MessageSignal messageSignal)	The decoding information for a specific message which supports higher order data types.
default SignalDecoder.Builder	obdSignal(Consumer<ObdSignal.Builder> obdSignal)	Information about signal decoder using the on-board diagnostic (OBD) II protocol.
SignalDecoder.Builder	obdSignal(ObdSignal obdSignal)	Information about signal decoder using the on-board diagnostic (OBD) II protocol.
SignalDecoder.Builder	type(String type)	The network protocol for the vehicle.
SignalDecoder.Builder	type(SignalDecoderType type)	The network protocol for the vehicle.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

fullyQualifiedName

SignalDecoder.Builder fullyQualifiedName(String fullyQualifiedName)

The fully qualified name of a signal decoder as defined in a vehicle model.

Parameters:

fullyQualifiedName - The fully qualified name of a signal decoder as defined in a vehicle model.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

SignalDecoder.Builder type(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SignalDecoderType, SignalDecoderType

type

SignalDecoder.Builder type(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SignalDecoderType, SignalDecoderType

interfaceId

SignalDecoder.Builder interfaceId(String interfaceId)

The ID of a network interface that specifies what network protocol a vehicle follows.

Parameters:

interfaceId - The ID of a network interface that specifies what network protocol a vehicle follows.

Returns:

Returns a reference to this object so that method calls can be chained together.

canSignal

SignalDecoder.Builder canSignal(CanSignal canSignal)

Information about signal decoder using the Controller Area Network (CAN) protocol.

Parameters:

canSignal - Information about signal decoder using the Controller Area Network (CAN) protocol.

Returns:

Returns a reference to this object so that method calls can be chained together.

canSignal

default SignalDecoder.Builder canSignal(Consumer<CanSignal.Builder> canSignal)

Information about signal decoder using the Controller Area Network (CAN) protocol.

This is a convenience method that creates an instance of the CanSignal.Builder avoiding the need to create one manually via CanSignal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canSignal(CanSignal).

Parameters:

canSignal - a consumer that will call methods on CanSignal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

canSignal(CanSignal)

obdSignal

SignalDecoder.Builder obdSignal(ObdSignal obdSignal)

Information about signal decoder using the on-board diagnostic (OBD) II protocol.

Parameters:

obdSignal - Information about signal decoder using the on-board diagnostic (OBD) II protocol.

Returns:

Returns a reference to this object so that method calls can be chained together.

obdSignal

default SignalDecoder.Builder obdSignal(Consumer<ObdSignal.Builder> obdSignal)

Information about signal decoder using the on-board diagnostic (OBD) II protocol.

This is a convenience method that creates an instance of the ObdSignal.Builder avoiding the need to create one manually via ObdSignal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to obdSignal(ObdSignal).

Parameters:

obdSignal - a consumer that will call methods on ObdSignal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

obdSignal(ObdSignal)

messageSignal

SignalDecoder.Builder messageSignal(MessageSignal messageSignal)

The decoding information for a specific message which supports higher order data types.

Parameters:

messageSignal - The decoding information for a specific message which supports higher order data types.

Returns:

Returns a reference to this object so that method calls can be chained together.

messageSignal

default SignalDecoder.Builder messageSignal(Consumer<MessageSignal.Builder> messageSignal)

The decoding information for a specific message which supports higher order data types.

This is a convenience method that creates an instance of the MessageSignal.Builder avoiding the need to create one manually via MessageSignal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageSignal(MessageSignal).

Parameters:

messageSignal - a consumer that will call methods on MessageSignal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

messageSignal(MessageSignal)

customDecodingSignal

SignalDecoder.Builder customDecodingSignal(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customDecodingSignal

default SignalDecoder.Builder customDecodingSignal(Consumer<CustomDecodingSignal.Builder> 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.

This is a convenience method that creates an instance of the CustomDecodingSignal.Builder avoiding the need to create one manually via CustomDecodingSignal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDecodingSignal(CustomDecodingSignal).

Parameters:

customDecodingSignal - a consumer that will call methods on CustomDecodingSignal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

customDecodingSignal(CustomDecodingSignal)