org.eclipse.milo.opcua.sdk.client.model.types.objects

Interface SessionDiagnosticsObjectType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

SessionDiagnosticsObjectTypeNode

public interface SessionDiagnosticsObjectType
extends BaseObjectType

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType	getSessionDiagnostics() Get the local value of the SessionDiagnostics Node.
SessionDiagnosticsVariableType	getSessionDiagnosticsNode() Get the SessionDiagnostics SessionDiagnosticsVariableType Node, or null if it does not exist.
CompletableFuture<? extends SessionDiagnosticsVariableType>	getSessionDiagnosticsNodeAsync() Asynchronous implementation of getSessionDiagnosticsNode().
org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType	getSessionSecurityDiagnostics() Get the local value of the SessionSecurityDiagnostics Node.
SessionSecurityDiagnosticsType	getSessionSecurityDiagnosticsNode() Get the SessionSecurityDiagnostics SessionSecurityDiagnosticsType Node, or null if it does not exist.
CompletableFuture<? extends SessionSecurityDiagnosticsType>	getSessionSecurityDiagnosticsNodeAsync() Asynchronous implementation of getSessionSecurityDiagnosticsNode().
org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[]	getSubscriptionDiagnosticsArray() Get the local value of the SubscriptionDiagnosticsArray Node.
SubscriptionDiagnosticsArrayType	getSubscriptionDiagnosticsArrayNode() Get the SubscriptionDiagnosticsArray SubscriptionDiagnosticsArrayType Node, or null if it does not exist.
CompletableFuture<? extends SubscriptionDiagnosticsArrayType>	getSubscriptionDiagnosticsArrayNodeAsync() Asynchronous implementation of getSubscriptionDiagnosticsArrayNode().
org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType	readSessionDiagnostics() Read the value of the SessionDiagnostics Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType>	readSessionDiagnosticsAsync() An asynchronous implementation of readSessionDiagnostics().
org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType	readSessionSecurityDiagnostics() Read the value of the SessionSecurityDiagnostics Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType>	readSessionSecurityDiagnosticsAsync() An asynchronous implementation of readSessionSecurityDiagnostics().
org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[]	readSubscriptionDiagnosticsArray() Read the value of the SubscriptionDiagnosticsArray Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[]>	readSubscriptionDiagnosticsArrayAsync() An asynchronous implementation of readSubscriptionDiagnosticsArray().
void	setSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics) Set the local value of the SessionDiagnostics Node.
void	setSessionSecurityDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics) Set the local value of the SessionSecurityDiagnostics Node.
void	setSubscriptionDiagnosticsArray(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray) Set the local value of the SubscriptionDiagnosticsArray Node.
void	writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics) Write a new value for the SessionDiagnostics Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSessionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics) An asynchronous implementation of writeSessionDiagnostics(SessionDiagnosticsDataType).
void	writeSessionSecurityDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics) Write a new value for the SessionSecurityDiagnostics Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSessionSecurityDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics) An asynchronous implementation of writeSessionSecurityDiagnostics(SessionSecurityDiagnosticsDataType).
void	writeSubscriptionDiagnosticsArray(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray) Write a new value for the SubscriptionDiagnosticsArray Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSubscriptionDiagnosticsArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray) An asynchronous implementation of writeSubscriptionDiagnosticsArray(SubscriptionDiagnosticsDataType[]).

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

getEventNotifier, setEventNotifier

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Method Detail

getSessionDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType getSessionDiagnostics()
                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SessionDiagnostics Node.

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

Returns:

the local value of the SessionDiagnostics Node.

Throws:

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

setSessionDiagnostics

void setSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SessionDiagnostics Node.

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

Parameters:

sessionDiagnostics - the local value to set for the SessionDiagnostics Node.

Throws:

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

readSessionDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType readSessionDiagnostics()
                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the SessionDiagnosticsDataType value read from the server.

Throws:

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

writeSessionDiagnostics

void writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

sessionDiagnostics - the SessionDiagnosticsDataType value to write to the server.

Throws:

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

readSessionDiagnosticsAsync

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

An asynchronous implementation of readSessionDiagnostics().

Returns:

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

writeSessionDiagnosticsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSessionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics)

An asynchronous implementation of writeSessionDiagnostics(SessionDiagnosticsDataType).

Returns:

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

getSessionDiagnosticsNode

SessionDiagnosticsVariableType getSessionDiagnosticsNode()
                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the SessionDiagnostics SessionDiagnosticsVariableType Node, or null if it does not exist.

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

Returns:

the SessionDiagnostics SessionDiagnosticsVariableType 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.

getSessionDiagnosticsNodeAsync

CompletableFuture<? extends SessionDiagnosticsVariableType> getSessionDiagnosticsNodeAsync()

Asynchronous implementation of getSessionDiagnosticsNode().

Returns:

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

getSessionSecurityDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType getSessionSecurityDiagnostics()
                                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SessionSecurityDiagnostics Node.

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

Returns:

the local value of the SessionSecurityDiagnostics Node.

Throws:

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

setSessionSecurityDiagnostics

void setSessionSecurityDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SessionSecurityDiagnostics Node.

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

Parameters:

sessionSecurityDiagnostics - the local value to set for the SessionSecurityDiagnostics Node.

Throws:

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

readSessionSecurityDiagnostics

org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType readSessionSecurityDiagnostics()
                                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the SessionSecurityDiagnosticsDataType value read from the server.

Throws:

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

writeSessionSecurityDiagnostics

void writeSessionSecurityDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics)
                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

sessionSecurityDiagnostics - the SessionSecurityDiagnosticsDataType value to write to the server.

Throws:

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

readSessionSecurityDiagnosticsAsync

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

An asynchronous implementation of readSessionSecurityDiagnostics().

Returns:

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

writeSessionSecurityDiagnosticsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSessionSecurityDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionSecurityDiagnosticsDataType sessionSecurityDiagnostics)

An asynchronous implementation of writeSessionSecurityDiagnostics(SessionSecurityDiagnosticsDataType).

Returns:

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

getSessionSecurityDiagnosticsNode

SessionSecurityDiagnosticsType getSessionSecurityDiagnosticsNode()
                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the SessionSecurityDiagnostics SessionSecurityDiagnosticsType Node, or null if it does not exist.

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

Returns:

the SessionSecurityDiagnostics SessionSecurityDiagnosticsType 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.

getSessionSecurityDiagnosticsNodeAsync

CompletableFuture<? extends SessionSecurityDiagnosticsType> getSessionSecurityDiagnosticsNodeAsync()

Asynchronous implementation of getSessionSecurityDiagnosticsNode().

Returns:

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

getSubscriptionDiagnosticsArray

org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] getSubscriptionDiagnosticsArray()
                                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SubscriptionDiagnosticsArray Node.

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

Returns:

the local value of the SubscriptionDiagnosticsArray Node.

Throws:

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

setSubscriptionDiagnosticsArray

void setSubscriptionDiagnosticsArray(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SubscriptionDiagnosticsArray Node.

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

Parameters:

subscriptionDiagnosticsArray - the local value to set for the SubscriptionDiagnosticsArray Node.

Throws:

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

readSubscriptionDiagnosticsArray

org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] readSubscriptionDiagnosticsArray()
                                                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SubscriptionDiagnosticsArray 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.

writeSubscriptionDiagnosticsArray

void writeSubscriptionDiagnosticsArray(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray)
                                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

subscriptionDiagnosticsArray - the SubscriptionDiagnosticsDataType[] value to write to the server.

Throws:

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

readSubscriptionDiagnosticsArrayAsync

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

An asynchronous implementation of readSubscriptionDiagnosticsArray().

Returns:

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

writeSubscriptionDiagnosticsArrayAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSubscriptionDiagnosticsArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionDiagnosticsDataType[] subscriptionDiagnosticsArray)

An asynchronous implementation of writeSubscriptionDiagnosticsArray(SubscriptionDiagnosticsDataType[]).

Returns:

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

getSubscriptionDiagnosticsArrayNode

SubscriptionDiagnosticsArrayType getSubscriptionDiagnosticsArrayNode()
                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the SubscriptionDiagnosticsArray SubscriptionDiagnosticsArrayType Node, or null if it does not exist.

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

Returns:

the SubscriptionDiagnosticsArray SubscriptionDiagnosticsArrayType 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.

getSubscriptionDiagnosticsArrayNodeAsync

CompletableFuture<? extends SubscriptionDiagnosticsArrayType> getSubscriptionDiagnosticsArrayNodeAsync()

Asynchronous implementation of getSubscriptionDiagnosticsArrayNode().

Returns:

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