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

Interface PublishedDataSetType

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

  • Field Details

    • CONFIGURATION_VERSION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType> CONFIGURATION_VERSION

    • DATA_SET_META_DATA

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType> DATA_SET_META_DATA

    • DATA_SET_CLASS_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<UUID> DATA_SET_CLASS_ID

    • CYCLIC_DATA_SET

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> CYCLIC_DATA_SET

  • Method Details

    • getConfigurationVersion

      org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType getConfigurationVersion() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ConfigurationVersion Node.

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

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

    • setConfigurationVersion

      void setConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ConfigurationVersion Node.

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

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

    • readConfigurationVersion

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

    • writeConfigurationVersion

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

    • readConfigurationVersionAsync

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

    • writeConfigurationVersionAsync

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

    • getConfigurationVersionNode

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

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

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

    • getConfigurationVersionNodeAsync

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

    • getDataSetMetaData

      org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType getDataSetMetaData() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetMetaData Node.

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

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

    • setDataSetMetaData

      void setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetMetaData Node.

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

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

    • readDataSetMetaData

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

    • writeDataSetMetaData

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

    • readDataSetMetaDataAsync

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

    • writeDataSetMetaDataAsync

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

    • getDataSetMetaDataNode

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

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

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

    • getDataSetMetaDataNodeAsync

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

    • getDataSetClassId

      UUID getDataSetClassId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetClassId Node.

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

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

    • setDataSetClassId

      void setDataSetClassId(UUID value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetClassId Node.

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

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

    • readDataSetClassId

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

    • writeDataSetClassId

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

    • readDataSetClassIdAsync

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

    • writeDataSetClassIdAsync

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

    • getDataSetClassIdNode

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

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

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

    • getDataSetClassIdNodeAsync

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

    • getCyclicDataSet

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

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

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

    • setCyclicDataSet

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

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

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

    • readCyclicDataSet

      Boolean readCyclicDataSet() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the CyclicDataSet 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.

    • writeCyclicDataSet

      void writeCyclicDataSet(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the CyclicDataSet 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.

    • readCyclicDataSetAsync

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

    • writeCyclicDataSetAsync

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

    • getCyclicDataSetNode

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

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

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

    • getCyclicDataSetNodeAsync

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

    • getExtensionFieldsNode

      ExtensionFieldsType getExtensionFieldsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the ExtensionFields ExtensionFieldsType Node, or null if it does not exist.

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

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

    • getExtensionFieldsNodeAsync

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