Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.objects

Interface LldpPortInformationType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
LldpPortInformationTypeNode
public interface LldpPortInformationType extends BaseObjectType
See Also:

  • Field Details

    • IETF_BASE_NETWORK_INTERFACE_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> IETF_BASE_NETWORK_INTERFACE_NAME

    • DEST_MAC_ADDRESS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[]> DEST_MAC_ADDRESS

    • PORT_ID_SUBTYPE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype> PORT_ID_SUBTYPE

    • PORT_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> PORT_ID

    • PORT_DESCRIPTION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> PORT_DESCRIPTION

    • MANAGEMENT_ADDRESS_TX_PORT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[]> MANAGEMENT_ADDRESS_TX_PORT

  • Method Details

    • getIetfBaseNetworkInterfaceName

      String getIetfBaseNetworkInterfaceName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the IetfBaseNetworkInterfaceName Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the IetfBaseNetworkInterfaceName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IetfBaseNetworkInterfaceName Node.

    • setIetfBaseNetworkInterfaceName

      void setIetfBaseNetworkInterfaceName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the IetfBaseNetworkInterfaceName Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the IetfBaseNetworkInterfaceName Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IetfBaseNetworkInterfaceName Node.

    • readIetfBaseNetworkInterfaceName

      String readIetfBaseNetworkInterfaceName() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the IetfBaseNetworkInterfaceName Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeIetfBaseNetworkInterfaceName

      void writeIetfBaseNetworkInterfaceName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the IetfBaseNetworkInterfaceName Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readIetfBaseNetworkInterfaceNameAsync

      CompletableFuture<? extends String> readIetfBaseNetworkInterfaceNameAsync()
      An asynchronous implementation of readIetfBaseNetworkInterfaceName().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeIetfBaseNetworkInterfaceNameAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIetfBaseNetworkInterfaceNameAsync(String value)
      An asynchronous implementation of writeIetfBaseNetworkInterfaceName(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getIetfBaseNetworkInterfaceNameNode

      PropertyType getIetfBaseNetworkInterfaceNameNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the IetfBaseNetworkInterfaceName PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the IetfBaseNetworkInterfaceName PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getIetfBaseNetworkInterfaceNameNodeAsync

      CompletableFuture<? extends PropertyType> getIetfBaseNetworkInterfaceNameNodeAsync()
      Asynchronous implementation of getIetfBaseNetworkInterfaceNameNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getDestMacAddress

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[] getDestMacAddress() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DestMacAddress Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the DestMacAddress Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the DestMacAddress Node.

    • setDestMacAddress

      void setDestMacAddress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DestMacAddress Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the DestMacAddress Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the DestMacAddress Node.

    • readDestMacAddress

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[] readDestMacAddress() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the DestMacAddress Node from the server and update the local value if the operation succeeds.
      Returns:
      the UByte value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeDestMacAddress

      void writeDestMacAddress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the DestMacAddress Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UByte value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readDestMacAddressAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[]> readDestMacAddressAsync()
      An asynchronous implementation of readDestMacAddress().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeDestMacAddressAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDestMacAddressAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[] value)
      An asynchronous implementation of writeDestMacAddress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getDestMacAddressNode

      PropertyType getDestMacAddressNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the DestMacAddress PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the DestMacAddress PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getDestMacAddressNodeAsync

      CompletableFuture<? extends PropertyType> getDestMacAddressNodeAsync()
      Asynchronous implementation of getDestMacAddressNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getPortIdSubtype

      org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype getPortIdSubtype() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PortIdSubtype Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the PortIdSubtype Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortIdSubtype Node.

    • setPortIdSubtype

      void setPortIdSubtype(org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PortIdSubtype Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the PortIdSubtype Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortIdSubtype Node.

    • readPortIdSubtype

      org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype readPortIdSubtype() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PortIdSubtype Node from the server and update the local value if the operation succeeds.
      Returns:
      the PortIdSubtype value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writePortIdSubtype

      void writePortIdSubtype(org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PortIdSubtype Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the PortIdSubtype value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readPortIdSubtypeAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype> readPortIdSubtypeAsync()
      An asynchronous implementation of readPortIdSubtype().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writePortIdSubtypeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePortIdSubtypeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype value)
      An asynchronous implementation of writePortIdSubtype(org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getPortIdSubtypeNode

      PropertyType getPortIdSubtypeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the PortIdSubtype PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the PortIdSubtype PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getPortIdSubtypeNodeAsync

      CompletableFuture<? extends PropertyType> getPortIdSubtypeNodeAsync()
      Asynchronous implementation of getPortIdSubtypeNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getPortId

      String getPortId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PortId Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the PortId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortId Node.

    • setPortId

      void setPortId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PortId Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the PortId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortId Node.

    • readPortId

      String readPortId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PortId Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writePortId

      void writePortId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PortId Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readPortIdAsync

      CompletableFuture<? extends String> readPortIdAsync()
      An asynchronous implementation of readPortId().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writePortIdAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePortIdAsync(String value)
      An asynchronous implementation of writePortId(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getPortIdNode

      PropertyType getPortIdNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the PortId PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the PortId PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getPortIdNodeAsync

      CompletableFuture<? extends PropertyType> getPortIdNodeAsync()
      Asynchronous implementation of getPortIdNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getPortDescription

      String getPortDescription() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PortDescription Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the PortDescription Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortDescription Node.

    • setPortDescription

      void setPortDescription(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PortDescription Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the PortDescription Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PortDescription Node.

    • readPortDescription

      String readPortDescription() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PortDescription Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writePortDescription

      void writePortDescription(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PortDescription Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readPortDescriptionAsync

      CompletableFuture<? extends String> readPortDescriptionAsync()
      An asynchronous implementation of readPortDescription().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writePortDescriptionAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePortDescriptionAsync(String value)
      An asynchronous implementation of writePortDescription(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getPortDescriptionNode

      PropertyType getPortDescriptionNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the PortDescription PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the PortDescription PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getPortDescriptionNodeAsync

      CompletableFuture<? extends PropertyType> getPortDescriptionNodeAsync()
      Asynchronous implementation of getPortDescriptionNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getManagementAddressTxPort

      org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[] getManagementAddressTxPort() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ManagementAddressTxPort Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the ManagementAddressTxPort Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ManagementAddressTxPort Node.

    • setManagementAddressTxPort

      void setManagementAddressTxPort(org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ManagementAddressTxPort Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the ManagementAddressTxPort Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ManagementAddressTxPort Node.

    • readManagementAddressTxPort

      org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[] readManagementAddressTxPort() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ManagementAddressTxPort Node from the server and update the local value if the operation succeeds.
      Returns:
      the LldpManagementAddressTxPortType value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeManagementAddressTxPort

      void writeManagementAddressTxPort(org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ManagementAddressTxPort Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the LldpManagementAddressTxPortType value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readManagementAddressTxPortAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[]> readManagementAddressTxPortAsync()
      An asynchronous implementation of readManagementAddressTxPort().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeManagementAddressTxPortAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeManagementAddressTxPortAsync(org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[] value)
      An asynchronous implementation of writeManagementAddressTxPort(org.eclipse.milo.opcua.stack.core.types.structured.LldpManagementAddressTxPortType[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getManagementAddressTxPortNode

      PropertyType getManagementAddressTxPortNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the ManagementAddressTxPort PropertyType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the ManagementAddressTxPort PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getManagementAddressTxPortNodeAsync

      CompletableFuture<? extends PropertyType> getManagementAddressTxPortNodeAsync()
      Asynchronous implementation of getManagementAddressTxPortNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getRemoteSystemsDataNode

      FolderType getRemoteSystemsDataNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the RemoteSystemsData FolderType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the RemoteSystemsData FolderType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getRemoteSystemsDataNodeAsync

      CompletableFuture<? extends FolderType> getRemoteSystemsDataNodeAsync()
      Asynchronous implementation of getRemoteSystemsDataNode().
      Returns:
      a CompletableFuture that completes successfully with the FolderType Node or completes exceptionally if an error occurs creating or getting the Node.