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

Interface SessionDiagnosticsObjectType

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

  • Field Details

    • CURRENT_ROLE_IDS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]> CURRENT_ROLE_IDS

  • Method Details

    • getCurrentRoleIds

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] getCurrentRoleIds() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the CurrentRoleIds Node.

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

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

    • setCurrentRoleIds

      void setCurrentRoleIds(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the CurrentRoleIds Node.

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

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

    • readCurrentRoleIds

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

    • writeCurrentRoleIds

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

    • readCurrentRoleIdsAsync

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

    • writeCurrentRoleIdsAsync

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

    • getCurrentRoleIdsNode

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

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

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

    • getCurrentRoleIdsNodeAsync

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

    • getSessionDiagnostics

      org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType getSessionDiagnostics() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SessionDiagnostics Node.

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

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

    • setSessionDiagnostics

      void setSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SessionDiagnostics Node.

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

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

    • readSessionDiagnostics

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

    • writeSessionDiagnostics

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

    • readSessionDiagnosticsAsync

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

    • writeSessionDiagnosticsAsync

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

    • getSessionDiagnosticsNode

      SessionDiagnosticsVariableType getSessionDiagnosticsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SessionDiagnostics SessionDiagnosticsVariableType Node, or null if it does not exist.

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

      Returns:
      the SessionDiagnostics SessionDiagnosticsVariableType 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.

    • getSessionDiagnosticsNodeAsync

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

    • getSessionSecurityDiagnostics

      org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType getSessionSecurityDiagnostics() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SessionSecurityDiagnostics Node.

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

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

    • setSessionSecurityDiagnostics

      void setSessionSecurityDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SessionSecurityDiagnostics Node.

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

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

    • readSessionSecurityDiagnostics

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

    • writeSessionSecurityDiagnostics

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

    • readSessionSecurityDiagnosticsAsync

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

    • writeSessionSecurityDiagnosticsAsync

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

    • getSessionSecurityDiagnosticsNode

      SessionSecurityDiagnosticsType getSessionSecurityDiagnosticsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SessionSecurityDiagnostics SessionSecurityDiagnosticsType Node, or null if it does not exist.

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

      Returns:
      the SessionSecurityDiagnostics SessionSecurityDiagnosticsType 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.

    • getSessionSecurityDiagnosticsNodeAsync

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

    • getSubscriptionDiagnosticsArray

      org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] getSubscriptionDiagnosticsArray() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SubscriptionDiagnosticsArray Node.

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

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

    • setSubscriptionDiagnosticsArray

      void setSubscriptionDiagnosticsArray(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SubscriptionDiagnosticsArray Node.

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

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

    • readSubscriptionDiagnosticsArray

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

    • writeSubscriptionDiagnosticsArray

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

    • readSubscriptionDiagnosticsArrayAsync

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

    • writeSubscriptionDiagnosticsArrayAsync

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

    • getSubscriptionDiagnosticsArrayNode

      SubscriptionDiagnosticsArrayType getSubscriptionDiagnosticsArrayNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SubscriptionDiagnosticsArray SubscriptionDiagnosticsArrayType Node, or null if it does not exist.

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

      Returns:
      the SubscriptionDiagnosticsArray SubscriptionDiagnosticsArrayType 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.

    • getSubscriptionDiagnosticsArrayNodeAsync

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