All Implemented Interfaces:
BaseObjectType, PublishedDataSetType, PublishedEventsType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class PublishedEventsTypeNode extends PublishedDataSetTypeNode implements PublishedEventsType
  • Constructor Details

    • PublishedEventsTypeNode

      public PublishedEventsTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)
  • Method Details

    • getPubSubEventNotifier

      public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getPubSubEventNotifier() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the local value of the PubSubEventNotifier Node.

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

      Specified by:
      getPubSubEventNotifier in interface PublishedEventsType
      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

      public void setPubSubEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Set the local value of the PubSubEventNotifier Node.

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

      Specified by:
      setPubSubEventNotifier in interface PublishedEventsType
      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

      public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readPubSubEventNotifier() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Read the value of the PubSubEventNotifier Node from the server and update the local value if the operation succeeds.
      Specified by:
      readPubSubEventNotifier in interface PublishedEventsType
      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

      public void writePubSubEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Write a new value for the PubSubEventNotifier Node to the server and update the local value if the operation succeeds.
      Specified by:
      writePubSubEventNotifier in interface PublishedEventsType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readPubSubEventNotifierAsync()
      Description copied from interface: PublishedEventsType
      An asynchronous implementation of PublishedEventsType.readPubSubEventNotifier().
      Specified by:
      readPubSubEventNotifierAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writePubSubEventNotifierAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePubSubEventNotifierAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId pubSubEventNotifier)
      Description copied from interface: PublishedEventsType
      Specified by:
      writePubSubEventNotifierAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getPubSubEventNotifierNode

      public PropertyTypeNode getPubSubEventNotifierNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the PubSubEventNotifier PropertyType Node, or null if it does not exist.

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

      Specified by:
      getPubSubEventNotifierNode in interface PublishedEventsType
      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

      public CompletableFuture<? extends PropertyTypeNode> getPubSubEventNotifierNodeAsync()
      Description copied from interface: PublishedEventsType
      Asynchronous implementation of PublishedEventsType.getPubSubEventNotifierNode().
      Specified by:
      getPubSubEventNotifierNodeAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getSelectedFields

      public org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] getSelectedFields() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the local value of the SelectedFields Node.

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

      Specified by:
      getSelectedFields in interface PublishedEventsType
      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

      public void setSelectedFields(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Set the local value of the SelectedFields Node.

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

      Specified by:
      setSelectedFields in interface PublishedEventsType
      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

      public org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] readSelectedFields() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Read the value of the SelectedFields Node from the server and update the local value if the operation succeeds.
      Specified by:
      readSelectedFields in interface PublishedEventsType
      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

      public void writeSelectedFields(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Write a new value for the SelectedFields Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeSelectedFields in interface PublishedEventsType
      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

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

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSelectedFieldsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] selectedFields)
      Description copied from interface: PublishedEventsType
      Specified by:
      writeSelectedFieldsAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getSelectedFieldsNode

      public PropertyTypeNode getSelectedFieldsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the SelectedFields PropertyType Node, or null if it does not exist.

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

      Specified by:
      getSelectedFieldsNode in interface PublishedEventsType
      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

      public CompletableFuture<? extends PropertyTypeNode> getSelectedFieldsNodeAsync()
      Description copied from interface: PublishedEventsType
      Asynchronous implementation of PublishedEventsType.getSelectedFieldsNode().
      Specified by:
      getSelectedFieldsNodeAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getFilter

      public org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter getFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the local value of the Filter Node.

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

      Specified by:
      getFilter in interface PublishedEventsType
      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

      public void setFilter(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Set the local value of the Filter Node.

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

      Specified by:
      setFilter in interface PublishedEventsType
      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

      public org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter readFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Read the value of the Filter Node from the server and update the local value if the operation succeeds.
      Specified by:
      readFilter in interface PublishedEventsType
      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

      public void writeFilter(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Write a new value for the Filter Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeFilter in interface PublishedEventsType
      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

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter> readFilterAsync()
      Description copied from interface: PublishedEventsType
      An asynchronous implementation of PublishedEventsType.readFilter().
      Specified by:
      readFilterAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeFilterAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeFilterAsync(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter filter)
      Description copied from interface: PublishedEventsType
      Specified by:
      writeFilterAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getFilterNode

      public PropertyTypeNode getFilterNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: PublishedEventsType
      Get the Filter PropertyType Node, or null if it does not exist.

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

      Specified by:
      getFilterNode in interface PublishedEventsType
      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

      public CompletableFuture<? extends PropertyTypeNode> getFilterNodeAsync()
      Description copied from interface: PublishedEventsType
      Asynchronous implementation of PublishedEventsType.getFilterNode().
      Specified by:
      getFilterNodeAsync in interface PublishedEventsType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.