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

Interface PubSubDiagnosticsType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
PubSubDiagnosticsConnectionType, PubSubDiagnosticsDataSetReaderType, PubSubDiagnosticsDataSetWriterType, PubSubDiagnosticsReaderGroupType, PubSubDiagnosticsRootType, PubSubDiagnosticsWriterGroupType
All Known Implementing Classes:
PubSubDiagnosticsConnectionTypeNode, PubSubDiagnosticsDataSetReaderTypeNode, PubSubDiagnosticsDataSetWriterTypeNode, PubSubDiagnosticsReaderGroupTypeNode, PubSubDiagnosticsRootTypeNode, PubSubDiagnosticsTypeNode, PubSubDiagnosticsWriterGroupTypeNode
public interface PubSubDiagnosticsType extends BaseObjectType
See Also:

  • Method Details

    • getDiagnosticsLevel

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

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

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

    • setDiagnosticsLevel

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

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

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

    • readDiagnosticsLevel

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

    • writeDiagnosticsLevel

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

    • readDiagnosticsLevelAsync

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

    • writeDiagnosticsLevelAsync

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

    • getDiagnosticsLevelNode

      BaseDataVariableType getDiagnosticsLevelNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the DiagnosticsLevel BaseDataVariableType Node, or null if it does not exist.

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

      Returns:
      the DiagnosticsLevel BaseDataVariableType 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.

    • getDiagnosticsLevelNodeAsync

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

    • getTotalInformation

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getTotalInformation() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TotalInformation Node.

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

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

    • setTotalInformation

      void setTotalInformation(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TotalInformation Node.

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

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

    • readTotalInformation

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

    • writeTotalInformation

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

    • readTotalInformationAsync

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

    • writeTotalInformationAsync

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

    • getTotalInformationNode

      PubSubDiagnosticsCounterType getTotalInformationNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TotalInformation PubSubDiagnosticsCounterType Node, or null if it does not exist.

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

      Returns:
      the TotalInformation PubSubDiagnosticsCounterType 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.

    • getTotalInformationNodeAsync

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

    • getTotalError

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getTotalError() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TotalError Node.

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

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

    • setTotalError

      void setTotalError(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TotalError Node.

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

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

    • readTotalError

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

    • writeTotalError

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

    • readTotalErrorAsync

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

    • writeTotalErrorAsync

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

    • getTotalErrorNode

      PubSubDiagnosticsCounterType getTotalErrorNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TotalError PubSubDiagnosticsCounterType Node, or null if it does not exist.

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

      Returns:
      the TotalError PubSubDiagnosticsCounterType 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.

    • getTotalErrorNodeAsync

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

    • getSubError

      Boolean getSubError() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SubError Node.

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

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

    • setSubError

      void setSubError(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SubError Node.

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

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

    • readSubError

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

    • writeSubError

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

    • readSubErrorAsync

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

    • writeSubErrorAsync

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

    • getSubErrorNode

      BaseDataVariableType getSubErrorNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SubError BaseDataVariableType Node, or null if it does not exist.

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

      Returns:
      the SubError BaseDataVariableType 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.

    • getSubErrorNodeAsync

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

    • getCountersNode

      BaseObjectType getCountersNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Counters BaseObjectType Node, or null if it does not exist.

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

      Returns:
      the Counters BaseObjectType 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.

    • getCountersNodeAsync

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

    • getLiveValuesNode

      BaseObjectType getLiveValuesNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the LiveValues BaseObjectType Node, or null if it does not exist.

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

      Returns:
      the LiveValues BaseObjectType 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.

    • getLiveValuesNodeAsync

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