Interface JsonDataSetWriterMessageType

All Superinterfaces:
BaseObjectType, DataSetWriterMessageType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
JsonDataSetWriterMessageTypeNode

public interface JsonDataSetWriterMessageType extends DataSetWriterMessageType
See Also:
  • Field Details

    • DATA_SET_MESSAGE_CONTENT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask> DATA_SET_MESSAGE_CONTENT_MASK
  • Method Details

    • getDataSetMessageContentMask

      org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask getDataSetMessageContentMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetMessageContentMask Node.

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

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

      void setDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetMessageContentMask Node.

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

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

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

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

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

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetMessageContentMaskAsync(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask value)
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getDataSetMessageContentMaskNode

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

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

      Returns:
      the DataSetMessageContentMask 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.
    • getDataSetMessageContentMaskNodeAsync

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