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

Class NetworkInterface

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.NetworkInterface

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>

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

Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the API operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NetworkInterface.Builder

Method Summary

Modifier and Type	Method	Description
static NetworkInterface.Builder	builder()
CanInterface	canInterface()	Information about a network interface specified by the Controller Area Network (CAN) protocol.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	interfaceId()	The ID of the network interface.
ObdInterface	obdInterface()	Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
List<SdkField<?>>	sdkFields()
static Class<? extends NetworkInterface.Builder>	serializableBuilderClass()
NetworkInterface.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NetworkInterfaceType	type()	The network protocol for the vehicle.
String	typeAsString()	The network protocol for the vehicle.
VehicleMiddleware	vehicleMiddleware()	The vehicle middleware defined as a type of network interface.

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

interfaceId

public final String interfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

type

public final NetworkInterfaceType 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 NetworkInterfaceType.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:

NetworkInterfaceType

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 NetworkInterfaceType.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:

NetworkInterfaceType

canInterface

public final CanInterface canInterface()

Information about a network interface specified by the Controller Area Network (CAN) protocol.

Returns:

Information about a network interface specified by the Controller Area Network (CAN) protocol.

obdInterface

public final ObdInterface obdInterface()

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

Returns:

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

vehicleMiddleware

public final VehicleMiddleware vehicleMiddleware()

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.

Returns:

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.

toBuilder

public NetworkInterface.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>

builder

public static NetworkInterface.Builder builder()

serializableBuilderClass

public static Class<? extends NetworkInterface.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