NetworkInterface (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotfleetwise.model.NetworkInterface

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NetworkInterface
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NetworkInterface()

Constructors
Constructor and Description
`NetworkInterface()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkInterface`	`clone()`
`boolean`	`equals(Object obj)`
`CanInterface`	`getCanInterface()` Information about a network interface specified by the Controller Area Network (CAN) protocol.
`String`	`getInterfaceId()` The ID of the network interface.
`ObdInterface`	`getObdInterface()` Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
`String`	`getType()` The network protocol for the vehicle.
`VehicleMiddleware`	`getVehicleMiddleware()` The vehicle middleware defined as a type of network interface.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCanInterface(CanInterface canInterface)` Information about a network interface specified by the Controller Area Network (CAN) protocol.
`void`	`setInterfaceId(String interfaceId)` The ID of the network interface.
`void`	`setObdInterface(ObdInterface obdInterface)` Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
`void`	`setType(String type)` The network protocol for the vehicle.
`void`	`setVehicleMiddleware(VehicleMiddleware vehicleMiddleware)` The vehicle middleware defined as a type of network interface.
`String`	`toString()` Returns a string representation of this object.
`NetworkInterface`	`withCanInterface(CanInterface canInterface)` Information about a network interface specified by the Controller Area Network (CAN) protocol.
`NetworkInterface`	`withInterfaceId(String interfaceId)` The ID of the network interface.
`NetworkInterface`	`withObdInterface(ObdInterface obdInterface)` Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
`NetworkInterface`	`withType(NetworkInterfaceType type)` The network protocol for the vehicle.
`NetworkInterface`	`withType(String type)` The network protocol for the vehicle.
`NetworkInterface`	`withVehicleMiddleware(VehicleMiddleware vehicleMiddleware)` The vehicle middleware defined as a type of network interface.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NetworkInterface
```
public NetworkInterface()
```
- Method Detail
  - setInterfaceId
```
public void setInterfaceId(String interfaceId)
```
    The ID of the network interface.
    
    Parameters:
    
    interfaceId - The ID of the network interface.
  - getInterfaceId
```
public String getInterfaceId()
```
    The ID of the network interface.
    
    Returns:
    
    The ID of the network interface.
  - withInterfaceId
```
public NetworkInterface withInterfaceId(String interfaceId)
```
    The ID of the network interface.
    
    Parameters:
    
    interfaceId - The ID of the network interface.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(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.
    
    See Also:
    
    NetworkInterfaceType
  - getType
```
public String getType()
```
    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:
    
    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
  - withType
```
public NetworkInterface withType(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:
    
    NetworkInterfaceType
  - withType
```
public NetworkInterface withType(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.
    
    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:
    
    NetworkInterfaceType
  - setCanInterface
```
public void setCanInterface(CanInterface canInterface)
```
    Information about a network interface specified by the Controller Area Network (CAN) protocol.
    
    Parameters:
    
    canInterface - Information about a network interface specified by the Controller Area Network (CAN) protocol.
  - getCanInterface
```
public CanInterface getCanInterface()
```
    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.
  - withCanInterface
```
public NetworkInterface withCanInterface(CanInterface canInterface)
```
    Information about a network interface specified by the Controller Area Network (CAN) protocol.
    
    Parameters:
    
    canInterface - Information about a network interface specified by the Controller Area Network (CAN) protocol.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObdInterface
```
public void setObdInterface(ObdInterface obdInterface)
```
    Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
    
    Parameters:
    
    obdInterface - Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
  - getObdInterface
```
public ObdInterface getObdInterface()
```
    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.
  - withObdInterface
```
public NetworkInterface withObdInterface(ObdInterface obdInterface)
```
    Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
    
    Parameters:
    
    obdInterface - Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVehicleMiddleware
```
public void setVehicleMiddleware(VehicleMiddleware vehicleMiddleware)
```
    The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
    
    Parameters:
    
    vehicleMiddleware - The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
  - getVehicleMiddleware
```
public VehicleMiddleware getVehicleMiddleware()
```
    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.
  - withVehicleMiddleware
```
public NetworkInterface withVehicleMiddleware(VehicleMiddleware vehicleMiddleware)
```
    The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
    
    Parameters:
    
    vehicleMiddleware - The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
    
    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 NetworkInterface clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class NetworkInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetworkInterface

Method Detail

setInterfaceId

getInterfaceId

withInterfaceId

setType

getType

withType

withType

setCanInterface

getCanInterface

withCanInterface

setObdInterface

getObdInterface

withObdInterface

setVehicleMiddleware

getVehicleMiddleware

withVehicleMiddleware

toString

equals

hashCode

clone

marshall