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

Interface BrokerDataSetReaderTransportType

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

  • Field Details

    • QUEUE_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> QUEUE_NAME

    • RESOURCE_URI

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> RESOURCE_URI

    • AUTHENTICATION_PROFILE_URI

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> AUTHENTICATION_PROFILE_URI

    • REQUESTED_DELIVERY_GUARANTEE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.BrokerTransportQualityOfService> REQUESTED_DELIVERY_GUARANTEE

    • META_DATA_QUEUE_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> META_DATA_QUEUE_NAME

  • Method Details

    • getQueueName

      String getQueueName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the QueueName Node.

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

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

    • setQueueName

      void setQueueName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the QueueName Node.

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

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

    • readQueueName

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

    • writeQueueName

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

    • readQueueNameAsync

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

    • writeQueueNameAsync

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

    • getQueueNameNode

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

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

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

    • getQueueNameNodeAsync

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

    • getResourceUri

      String getResourceUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ResourceUri Node.

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

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

    • setResourceUri

      void setResourceUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ResourceUri Node.

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

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

    • readResourceUri

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

    • writeResourceUri

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

    • readResourceUriAsync

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

    • writeResourceUriAsync

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

    • getResourceUriNode

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

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

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

    • getResourceUriNodeAsync

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

    • getAuthenticationProfileUri

      String getAuthenticationProfileUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the AuthenticationProfileUri Node.

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

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

    • setAuthenticationProfileUri

      void setAuthenticationProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the AuthenticationProfileUri Node.

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

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

    • readAuthenticationProfileUri

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

    • writeAuthenticationProfileUri

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

    • readAuthenticationProfileUriAsync

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

    • writeAuthenticationProfileUriAsync

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

    • getAuthenticationProfileUriNode

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

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

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

    • getAuthenticationProfileUriNodeAsync

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

    • getRequestedDeliveryGuarantee

      org.eclipse.milo.opcua.stack.core.types.enumerated.BrokerTransportQualityOfService getRequestedDeliveryGuarantee() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RequestedDeliveryGuarantee Node.

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

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

    • setRequestedDeliveryGuarantee

      void setRequestedDeliveryGuarantee(org.eclipse.milo.opcua.stack.core.types.enumerated.BrokerTransportQualityOfService value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RequestedDeliveryGuarantee Node.

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

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

    • readRequestedDeliveryGuarantee

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

    • writeRequestedDeliveryGuarantee

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

    • readRequestedDeliveryGuaranteeAsync

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

    • writeRequestedDeliveryGuaranteeAsync

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

    • getRequestedDeliveryGuaranteeNode

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

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

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

    • getRequestedDeliveryGuaranteeNodeAsync

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

    • getMetaDataQueueName

      String getMetaDataQueueName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MetaDataQueueName Node.

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

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

    • setMetaDataQueueName

      void setMetaDataQueueName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MetaDataQueueName Node.

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

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

    • readMetaDataQueueName

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

    • writeMetaDataQueueName

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

    • readMetaDataQueueNameAsync

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

    • writeMetaDataQueueNameAsync

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

    • getMetaDataQueueNameNode

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

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

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

    • getMetaDataQueueNameNodeAsync

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