Interface NetworkInterface.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NetworkInterface.Builder,NetworkInterface>, SdkBuilder<NetworkInterface.Builder,NetworkInterface>, SdkPojo
Enclosing class:
NetworkInterface
public static interface NetworkInterface.Builder extends SdkPojo, CopyableBuilder<NetworkInterface.Builder,NetworkInterface>

  • Method Details

    • interfaceId

      NetworkInterface.Builder interfaceId(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.

    • type

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

    • type

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

    • canInterface

      NetworkInterface.Builder canInterface(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.

    • canInterface

      default NetworkInterface.Builder canInterface(Consumer<CanInterface.Builder> canInterface)

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

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

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

      Parameters:
      canInterface - a consumer that will call methods on CanInterface.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • obdInterface

      NetworkInterface.Builder obdInterface(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.

    • obdInterface

      default NetworkInterface.Builder obdInterface(Consumer<ObdInterface.Builder> obdInterface)

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

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

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

      Parameters:
      obdInterface - a consumer that will call methods on ObdInterface.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vehicleMiddleware

      NetworkInterface.Builder vehicleMiddleware(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.

    • vehicleMiddleware

      default NetworkInterface.Builder vehicleMiddleware(Consumer<VehicleMiddleware.Builder> vehicleMiddleware)

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

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

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

      Parameters:
      vehicleMiddleware - a consumer that will call methods on VehicleMiddleware.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: