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

Interface ServerStatusType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, VariableNode

All Known Implementing Classes:

ServerStatusTypeNode

public interface ServerStatusType
extends BaseDataVariableType

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo	getBuildInfo() Get the local value of the BuildInfo Node.
BuildInfoType	getBuildInfoNode() Get the BuildInfo BuildInfoType Node, or null if it does not exist.
CompletableFuture<? extends BuildInfoType>	getBuildInfoNodeAsync() Asynchronous implementation of getBuildInfoNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getCurrentTime() Get the local value of the CurrentTime Node.
BaseDataVariableType	getCurrentTimeNode() Get the CurrentTime BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getCurrentTimeNodeAsync() Asynchronous implementation of getCurrentTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getSecondsTillShutdown() Get the local value of the SecondsTillShutdown Node.
BaseDataVariableType	getSecondsTillShutdownNode() Get the SecondsTillShutdown BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getSecondsTillShutdownNodeAsync() Asynchronous implementation of getSecondsTillShutdownNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getShutdownReason() Get the local value of the ShutdownReason Node.
BaseDataVariableType	getShutdownReasonNode() Get the ShutdownReason BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getShutdownReasonNodeAsync() Asynchronous implementation of getShutdownReasonNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getStartTime() Get the local value of the StartTime Node.
BaseDataVariableType	getStartTimeNode() Get the StartTime BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getStartTimeNodeAsync() Asynchronous implementation of getStartTimeNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState	getState() Get the local value of the State Node.
BaseDataVariableType	getStateNode() Get the State BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getStateNodeAsync() Asynchronous implementation of getStateNode().
org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo	readBuildInfo() Read the value of the BuildInfo Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo>	readBuildInfoAsync() An asynchronous implementation of readBuildInfo().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readCurrentTime() Read the value of the CurrentTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readCurrentTimeAsync() An asynchronous implementation of readCurrentTime().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readSecondsTillShutdown() Read the value of the SecondsTillShutdown Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readSecondsTillShutdownAsync() An asynchronous implementation of readSecondsTillShutdown().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readShutdownReason() Read the value of the ShutdownReason Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readShutdownReasonAsync() An asynchronous implementation of readShutdownReason().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readStartTime() Read the value of the StartTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readStartTimeAsync() An asynchronous implementation of readStartTime().
org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState	readState() Read the value of the State Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState>	readStateAsync() An asynchronous implementation of readState().
void	setBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) Set the local value of the BuildInfo Node.
void	setCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) Set the local value of the CurrentTime Node.
void	setSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) Set the local value of the SecondsTillShutdown Node.
void	setShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) Set the local value of the ShutdownReason Node.
void	setStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) Set the local value of the StartTime Node.
void	setState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state) Set the local value of the State Node.
void	writeBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) Write a new value for the BuildInfo Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBuildInfoAsync(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo) An asynchronous implementation of writeBuildInfo(BuildInfo).
void	writeCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) Write a new value for the CurrentTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime) An asynchronous implementation of writeCurrentTime(DateTime).
void	writeSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) Write a new value for the SecondsTillShutdown Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecondsTillShutdownAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown) An asynchronous implementation of writeSecondsTillShutdown(UInteger).
void	writeShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) Write a new value for the ShutdownReason Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeShutdownReasonAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason) An asynchronous implementation of writeShutdownReason(LocalizedText).
void	writeStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) Write a new value for the StartTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeStartTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime) An asynchronous implementation of writeStartTime(DateTime).
void	writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state) Write a new value for the State Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state) An asynchronous implementation of writeState(ServerState).

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

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

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

getStartTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getStartTime()
                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the StartTime Node.

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

Returns:

the local value of the StartTime Node.

Throws:

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

setStartTime

void setStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the StartTime Node.

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

Parameters:

startTime - the local value to set for the StartTime Node.

Throws:

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

readStartTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readStartTime()
                                                                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the DateTime value read from the server.

Throws:

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

writeStartTime

void writeStartTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

startTime - the DateTime value to write to the server.

Throws:

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

readStartTimeAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readStartTimeAsync()

An asynchronous implementation of readStartTime().

Returns:

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

writeStartTimeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeStartTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime startTime)

An asynchronous implementation of writeStartTime(DateTime).

Returns:

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

getStartTimeNode

BaseDataVariableType getStartTimeNode()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the StartTime BaseDataVariableType Node, or null if it does not exist.

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

Returns:

the StartTime BaseDataVariableType 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.

getStartTimeNodeAsync

CompletableFuture<? extends BaseDataVariableType> getStartTimeNodeAsync()

Asynchronous implementation of getStartTimeNode().

Returns:

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

getCurrentTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getCurrentTime()
                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the CurrentTime Node.

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

Returns:

the local value of the CurrentTime Node.

Throws:

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

setCurrentTime

void setCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the CurrentTime Node.

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

Parameters:

currentTime - the local value to set for the CurrentTime Node.

Throws:

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

readCurrentTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readCurrentTime()
                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the DateTime value read from the server.

Throws:

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

writeCurrentTime

void writeCurrentTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

currentTime - the DateTime value to write to the server.

Throws:

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

readCurrentTimeAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readCurrentTimeAsync()

An asynchronous implementation of readCurrentTime().

Returns:

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

writeCurrentTimeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCurrentTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime currentTime)

An asynchronous implementation of writeCurrentTime(DateTime).

Returns:

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

getCurrentTimeNode

BaseDataVariableType getCurrentTimeNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the CurrentTime BaseDataVariableType Node, or null if it does not exist.

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

Returns:

the CurrentTime BaseDataVariableType 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.

getCurrentTimeNodeAsync

CompletableFuture<? extends BaseDataVariableType> getCurrentTimeNodeAsync()

Asynchronous implementation of getCurrentTimeNode().

Returns:

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

getState

org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState getState()
                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the State Node.

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

Returns:

the local value of the State Node.

Throws:

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

setState

void setState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)
       throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the State Node.

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

Parameters:

state - the local value to set for the State Node.

Throws:

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

readState

org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState readState()
                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ServerState value read from the server.

Throws:

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

writeState

void writeState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)
         throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

state - the ServerState value to write to the server.

Throws:

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

readStateAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState> readStateAsync()

An asynchronous implementation of readState().

Returns:

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

writeStateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState state)

An asynchronous implementation of writeState(ServerState).

Returns:

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

getStateNode

BaseDataVariableType getStateNode()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Get the State BaseDataVariableType Node, or null if it does not exist.

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

Returns:

the State BaseDataVariableType 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.

getStateNodeAsync

CompletableFuture<? extends BaseDataVariableType> getStateNodeAsync()

Asynchronous implementation of getStateNode().

Returns:

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

getBuildInfo

org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo getBuildInfo()
                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the BuildInfo Node.

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

Returns:

the local value of the BuildInfo Node.

Throws:

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

setBuildInfo

void setBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the BuildInfo Node.

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

Parameters:

buildInfo - the local value to set for the BuildInfo Node.

Throws:

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

readBuildInfo

org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo readBuildInfo()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the BuildInfo value read from the server.

Throws:

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

writeBuildInfo

void writeBuildInfo(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

buildInfo - the BuildInfo value to write to the server.

Throws:

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

readBuildInfoAsync

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

An asynchronous implementation of readBuildInfo().

Returns:

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

writeBuildInfoAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBuildInfoAsync(org.eclipse.milo.opcua.stack.core.types.structured.BuildInfo buildInfo)

An asynchronous implementation of writeBuildInfo(BuildInfo).

Returns:

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

getBuildInfoNode

BuildInfoType getBuildInfoNode()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the BuildInfo BuildInfoType Node, or null if it does not exist.

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

Returns:

the BuildInfo BuildInfoType 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.

getBuildInfoNodeAsync

CompletableFuture<? extends BuildInfoType> getBuildInfoNodeAsync()

Asynchronous implementation of getBuildInfoNode().

Returns:

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

getSecondsTillShutdown

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getSecondsTillShutdown()
                                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SecondsTillShutdown Node.

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

Returns:

the local value of the SecondsTillShutdown Node.

Throws:

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

setSecondsTillShutdown

void setSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SecondsTillShutdown Node.

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

Parameters:

secondsTillShutdown - the local value to set for the SecondsTillShutdown Node.

Throws:

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

readSecondsTillShutdown

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readSecondsTillShutdown()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UInteger value read from the server.

Throws:

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

writeSecondsTillShutdown

void writeSecondsTillShutdown(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

secondsTillShutdown - the UInteger value to write to the server.

Throws:

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

readSecondsTillShutdownAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readSecondsTillShutdownAsync()

An asynchronous implementation of readSecondsTillShutdown().

Returns:

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

writeSecondsTillShutdownAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecondsTillShutdownAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger secondsTillShutdown)

An asynchronous implementation of writeSecondsTillShutdown(UInteger).

Returns:

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

getSecondsTillShutdownNode

BaseDataVariableType getSecondsTillShutdownNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the SecondsTillShutdown BaseDataVariableType Node, or null if it does not exist.

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

Returns:

the SecondsTillShutdown BaseDataVariableType 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.

getSecondsTillShutdownNodeAsync

CompletableFuture<? extends BaseDataVariableType> getSecondsTillShutdownNodeAsync()

Asynchronous implementation of getSecondsTillShutdownNode().

Returns:

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

getShutdownReason

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getShutdownReason()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ShutdownReason Node.

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

Returns:

the local value of the ShutdownReason Node.

Throws:

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

setShutdownReason

void setShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ShutdownReason Node.

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

Parameters:

shutdownReason - the local value to set for the ShutdownReason Node.

Throws:

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

readShutdownReason

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readShutdownReason()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the LocalizedText value read from the server.

Throws:

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

writeShutdownReason

void writeShutdownReason(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

shutdownReason - the LocalizedText value to write to the server.

Throws:

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

readShutdownReasonAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readShutdownReasonAsync()

An asynchronous implementation of readShutdownReason().

Returns:

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

writeShutdownReasonAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeShutdownReasonAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText shutdownReason)

An asynchronous implementation of writeShutdownReason(LocalizedText).

Returns:

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

getShutdownReasonNode

BaseDataVariableType getShutdownReasonNode()
                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the ShutdownReason BaseDataVariableType Node, or null if it does not exist.

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

Returns:

the ShutdownReason BaseDataVariableType 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.

getShutdownReasonNodeAsync

CompletableFuture<? extends BaseDataVariableType> getShutdownReasonNodeAsync()

Asynchronous implementation of getShutdownReasonNode().

Returns:

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