Module org.eclipse.milo.opcua.sdk.client

Package org.eclipse.milo.opcua.sdk.client.model.variables

Interface SubscriptionDiagnosticsArrayType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

All Known Implementing Classes:

SubscriptionDiagnosticsArrayTypeNode

public interface SubscriptionDiagnosticsArrayType
extends BaseDataVariableType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part5/7.11

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType	getSubscriptionDiagnostics()	Get the local value of the SubscriptionDiagnostics Node.
SubscriptionDiagnosticsType	getSubscriptionDiagnosticsNode()	Get the SubscriptionDiagnostics SubscriptionDiagnosticsType Node, or null if it does not exist.
CompletableFuture<? extends SubscriptionDiagnosticsType>	getSubscriptionDiagnosticsNodeAsync()	Asynchronous implementation of getSubscriptionDiagnosticsNode().
org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType	readSubscriptionDiagnostics()	Read the value of the SubscriptionDiagnostics Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType>	readSubscriptionDiagnosticsAsync()	An asynchronous implementation of readSubscriptionDiagnostics().
void	setSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)	Set the local value of the SubscriptionDiagnostics Node.
void	writeSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)	Write a new value for the SubscriptionDiagnostics Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSubscriptionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)	An asynchronous implementation of writeSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType).

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Method Details

getSubscriptionDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType getSubscriptionDiagnostics()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SubscriptionDiagnostics Node.

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

Returns:

the local value of the SubscriptionDiagnostics Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SubscriptionDiagnostics Node.

setSubscriptionDiagnostics

void setSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SubscriptionDiagnostics Node.

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

Parameters:

value - the local value to set for the SubscriptionDiagnostics Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SubscriptionDiagnostics Node.

readSubscriptionDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType readSubscriptionDiagnostics()
                                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SubscriptionDiagnostics Node from the server and update the local value if the operation succeeds.

Returns:

the SubscriptionDiagnosticsDataType value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSubscriptionDiagnostics

void writeSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the SubscriptionDiagnostics Node to the server and update the local value if the operation succeeds.

Parameters:

value - the SubscriptionDiagnosticsDataType value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSubscriptionDiagnosticsAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType> readSubscriptionDiagnosticsAsync()

An asynchronous implementation of readSubscriptionDiagnostics().

Returns:

a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

writeSubscriptionDiagnosticsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSubscriptionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType value)

An asynchronous implementation of writeSubscriptionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSubscriptionDiagnosticsNode

SubscriptionDiagnosticsType getSubscriptionDiagnosticsNode()
                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the SubscriptionDiagnostics SubscriptionDiagnosticsType Node, or null if it does not exist.

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

Returns:

the SubscriptionDiagnostics SubscriptionDiagnosticsType 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.

getSubscriptionDiagnosticsNodeAsync

CompletableFuture<? extends SubscriptionDiagnosticsType> getSubscriptionDiagnosticsNodeAsync()

Asynchronous implementation of getSubscriptionDiagnosticsNode().

Returns:

a CompletableFuture that completes successfully with the SubscriptionDiagnosticsType Node or completes exceptionally if an error occurs creating or getting the Node.