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

Interface HistoricalEventConfigurationType

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

  • Field Details

    • START_OF_ARCHIVE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> START_OF_ARCHIVE

    • START_OF_ONLINE_ARCHIVE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> START_OF_ONLINE_ARCHIVE

    • SORT_BY_EVENT_FIELDS

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

  • Method Details

    • getStartOfArchive

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getStartOfArchive() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the StartOfArchive Node.

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

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

    • setStartOfArchive

      void setStartOfArchive(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the StartOfArchive Node.

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

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

    • readStartOfArchive

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

    • writeStartOfArchive

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

    • readStartOfArchiveAsync

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

    • writeStartOfArchiveAsync

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

    • getStartOfArchiveNode

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

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

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

    • getStartOfArchiveNodeAsync

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

    • getStartOfOnlineArchive

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getStartOfOnlineArchive() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the StartOfOnlineArchive Node.

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

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

    • setStartOfOnlineArchive

      void setStartOfOnlineArchive(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the StartOfOnlineArchive Node.

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

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

    • readStartOfOnlineArchive

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

    • writeStartOfOnlineArchive

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

    • readStartOfOnlineArchiveAsync

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

    • writeStartOfOnlineArchiveAsync

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

    • getStartOfOnlineArchiveNode

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

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

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

    • getStartOfOnlineArchiveNodeAsync

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

    • getSortByEventFields

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

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

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

    • setSortByEventFields

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

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

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

    • readSortByEventFields

      org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] readSortByEventFields() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SortByEventFields 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.

    • writeSortByEventFields

      void writeSortByEventFields(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SortByEventFields 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.

    • readSortByEventFieldsAsync

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

    • writeSortByEventFieldsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSortByEventFieldsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SimpleAttributeOperand[] value)
      An asynchronous implementation of writeSortByEventFields(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.

    • getSortByEventFieldsNode

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

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

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

    • getSortByEventFieldsNodeAsync

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

    • getEventTypesNode

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

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

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

    • getEventTypesNodeAsync

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