com.inductiveautomation.ignition.client.gateway_interface.messages

Class RunUpdateQueryMessage

java.lang.Object

com.inductiveautomation.ignition.client.gateway_interface.messages.MessageBuilder

com.inductiveautomation.ignition.client.gateway_interface.messages.RunUpdateQueryMessage

All Implemented Interfaces:

GatewayInterface.MessagePrinter

public class RunUpdateQueryMessage
extends MessageBuilder

Builds the proper message to invoke the RunUpdateQuery function

Constructor Summary

Constructors

Constructor and Description
RunUpdateQueryMessage(java.lang.String query)

Method Summary

Modifier and Type	Method and Description
RunUpdateQueryMessage	database(java.lang.String database)
RunUpdateQueryMessage	getIds(boolean getIds)
int	getMinConnectionMode() Minimum connection mode needed to run, or zero to always run.
StatMetric	getStatMetric() A stat metric to update when this message finishes.
static StatMetric	getUpdateQueryMetric()
RunUpdateQueryMessage	skipAudit(boolean skipAudit)
RunUpdateQueryMessage	transactionId(java.lang.String txId)

Methods inherited from class com.inductiveautomation.ignition.client.gateway_interface.messages.MessageBuilder

arg, arg, build, printMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunUpdateQueryMessage

public RunUpdateQueryMessage(java.lang.String query)

Method Detail

getStatMetric

public StatMetric getStatMetric()

Description copied from interface: GatewayInterface.MessagePrinter

A stat metric to update when this message finishes. Optional, may be null.

Specified by:

getStatMetric in interface GatewayInterface.MessagePrinter

Overrides:

getStatMetric in class MessageBuilder

getUpdateQueryMetric

public static StatMetric getUpdateQueryMetric()

database

public RunUpdateQueryMessage database(java.lang.String database)

transactionId

public RunUpdateQueryMessage transactionId(java.lang.String txId)

getIds

public RunUpdateQueryMessage getIds(boolean getIds)

skipAudit

public RunUpdateQueryMessage skipAudit(boolean skipAudit)

getMinConnectionMode

public int getMinConnectionMode()

Description copied from interface: GatewayInterface.MessagePrinter

Minimum connection mode needed to run, or zero to always run.

Specified by:

getMinConnectionMode in interface GatewayInterface.MessagePrinter

Overrides:

getMinConnectionMode in class MessageBuilder