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

Interface PublishedEventsType

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

  • Field Details

    • PUB_SUB_EVENT_NOTIFIER

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

    • SELECTED_FIELDS

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

    • FILTER

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter> FILTER

  • Method Details

    • getPubSubEventNotifier

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getPubSubEventNotifier() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PubSubEventNotifier Node.

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

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

    • setPubSubEventNotifier

      void setPubSubEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PubSubEventNotifier Node.

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

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

    • readPubSubEventNotifier

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readPubSubEventNotifier() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PubSubEventNotifier 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.

    • writePubSubEventNotifier

      void writePubSubEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PubSubEventNotifier 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.

    • readPubSubEventNotifierAsync

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

    • writePubSubEventNotifierAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePubSubEventNotifierAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
      An asynchronous implementation of writePubSubEventNotifier(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.

    • getPubSubEventNotifierNode

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

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

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

    • getPubSubEventNotifierNodeAsync

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

    • getSelectedFields

      org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] getSelectedFields() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SelectedFields Node.

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

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

    • setSelectedFields

      void setSelectedFields(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SelectedFields Node.

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

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

    • readSelectedFields

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

    • writeSelectedFields

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

    • readSelectedFieldsAsync

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

    • writeSelectedFieldsAsync

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

    • getSelectedFieldsNode

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

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

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

    • getSelectedFieldsNodeAsync

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

    • getFilter

      org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter getFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Filter Node.

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

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

    • setFilter

      void setFilter(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Filter Node.

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

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

    • readFilter

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

    • writeFilter

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

    • readFilterAsync

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

    • writeFilterAsync

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

    • getFilterNode

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

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

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

    • getFilterNodeAsync

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