= Cheatsheets

[[AclToken]]
== AclToken


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[id]]`id`|`String`|-
|[[name]]`name`|`String`|-
|[[rules]]`rules`|`String`|-
|[[type]]`type`|`link:enums.html#AclTokenType[AclTokenType]`|-
|===

[[BlockingQueryOptions]]
== BlockingQueryOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[wait]]`wait`|`String`|-
|===

[[Check]]
== Check


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[id]]`id`|`String`|-
|[[name]]`name`|`String`|-
|[[nodeName]]`nodeName`|`String`|-
|[[notes]]`notes`|`String`|-
|[[output]]`output`|`String`|-
|[[serviceId]]`serviceId`|`String`|-
|[[serviceName]]`serviceName`|`String`|-
|[[status]]`status`|`link:enums.html#CheckStatus[CheckStatus]`|-
|===

[[CheckList]]
== CheckList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Check[Check]`|-
|===

[[CheckOptions]]
== CheckOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[deregisterAfter]]`deregisterAfter`|`String`|-
|[[http]]`http`|`String`|-
|[[id]]`id`|`String`|-
|[[interval]]`interval`|`String`|-
|[[name]]`name`|`String`|-
|[[notes]]`notes`|`String`|-
|[[script]]`script`|`String`|-
|[[serviceId]]`serviceId`|`String`|-
|[[status]]`status`|`link:enums.html#CheckStatus[CheckStatus]`|-
|[[tcp]]`tcp`|`String`|-
|[[ttl]]`ttl`|`String`|-
|===

[[CheckQueryOptions]]
== CheckQueryOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[blockingOptions]]`blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|-
|[[near]]`near`|`String`|-
|===

[[ConsulClientOptions]]
== ConsulClientOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[aclToken]]`aclToken`|`String`|-
|[[alpnVersions]]`alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|-
|[[connectTimeout]]`connectTimeout`|`Number (int)`|-
|[[crlPaths]]`crlPaths`|`Array of String`|-
|[[crlValues]]`crlValues`|`Array of Buffer`|-
|[[dc]]`dc`|`String`|-
|[[decoderInitialBufferSize]]`decoderInitialBufferSize`|`Number (int)`|-
|[[defaultHost]]`defaultHost`|`String`|-
|[[defaultPort]]`defaultPort`|`Number (int)`|-
|[[enabledCipherSuites]]`enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`enabledSecureTransportProtocols`|`Array of String`|-
|[[followRedirects]]`followRedirects`|`Boolean`|-
|[[forceSni]]`forceSni`|`Boolean`|-
|[[http2ClearTextUpgrade]]`http2ClearTextUpgrade`|`Boolean`|-
|[[http2ConnectionWindowSize]]`http2ConnectionWindowSize`|`Number (int)`|-
|[[http2KeepAliveTimeout]]`http2KeepAliveTimeout`|`Number (int)`|-
|[[http2MaxPoolSize]]`http2MaxPoolSize`|`Number (int)`|-
|[[http2MultiplexingLimit]]`http2MultiplexingLimit`|`Number (int)`|-
|[[idleTimeout]]`idleTimeout`|`Number (int)`|-
|[[initialSettings]]`initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|-
|[[jdkSslEngineOptions]]`jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keepAlive]]`keepAlive`|`Boolean`|-
|[[keepAliveTimeout]]`keepAliveTimeout`|`Number (int)`|-
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[localAddress]]`localAddress`|`String`|-
|[[logActivity]]`logActivity`|`Boolean`|-
|[[maxChunkSize]]`maxChunkSize`|`Number (int)`|-
|[[maxHeaderSize]]`maxHeaderSize`|`Number (int)`|-
|[[maxInitialLineLength]]`maxInitialLineLength`|`Number (int)`|-
|[[maxPoolSize]]`maxPoolSize`|`Number (int)`|-
|[[maxRedirects]]`maxRedirects`|`Number (int)`|-
|[[maxWaitQueueSize]]`maxWaitQueueSize`|`Number (int)`|-
|[[maxWebsocketFrameSize]]`maxWebsocketFrameSize`|`Number (int)`|-
|[[maxWebsocketMessageSize]]`maxWebsocketMessageSize`|`Number (int)`|-
|[[metricsName]]`metricsName`|`String`|-
|[[openSslEngineOptions]]`openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pipelining]]`pipelining`|`Boolean`|-
|[[pipeliningLimit]]`pipeliningLimit`|`Number (int)`|-
|[[poolCleanerPeriod]]`poolCleanerPeriod`|`Number (int)`|-
|[[protocolVersion]]`protocolVersion`|`link:enums.html#HttpVersion[HttpVersion]`|-
|[[proxyOptions]]`proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[receiveBufferSize]]`receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`reuseAddress`|`Boolean`|-
|[[reusePort]]`reusePort`|`Boolean`|-
|[[sendBufferSize]]`sendBufferSize`|`Number (int)`|-
|[[sendUnmaskedFrames]]`sendUnmaskedFrames`|`Boolean`|-
|[[soLinger]]`soLinger`|`Number (int)`|-
|[[ssl]]`ssl`|`Boolean`|-
|[[tcpCork]]`tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`tcpQuickAck`|`Boolean`|-
|[[timeout]]`timeout`|`Number (long)`|-
|[[trafficClass]]`trafficClass`|`Number (int)`|-
|[[trustAll]]`trustAll`|`Boolean`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[tryUseCompression]]`tryUseCompression`|`Boolean`|-
|[[useAlpn]]`useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`usePooledBuffers`|`Boolean`|-
|[[userAgent]]`userAgent`|`String`|-
|[[userAgentEnabled]]`userAgentEnabled`|`Boolean`|-
|[[verifyHost]]`verifyHost`|`Boolean`|-
|===

[[Coordinate]]
== Coordinate


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[adj]]`adj`|`Number (float)`|-
|[[err]]`err`|`Number (float)`|-
|[[height]]`height`|`Number (float)`|-
|[[node]]`node`|`String`|-
|[[vec]]`vec`|`Array of Number (Float)`|-
|===

[[CoordinateList]]
== CoordinateList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Coordinate[Coordinate]`|-
|===

[[DcCoordinates]]
== DcCoordinates


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[datacenter]]`datacenter`|`String`|-
|[[servers]]`servers`|`Array of link:dataobjects.html#Coordinate[Coordinate]`|-
|===

[[Event]]
== Event


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[id]]`id`|`String`|-
|[[lTime]]`lTime`|`Number (int)`|-
|[[name]]`name`|`String`|-
|[[node]]`node`|`String`|-
|[[payload]]`payload`|`String`|-
|[[service]]`service`|`String`|-
|[[tag]]`tag`|`String`|-
|[[version]]`version`|`Number (int)`|-
|===

[[EventList]]
== EventList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Event[Event]`|-
|===

[[EventListOptions]]
== EventListOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[blockingOptions]]`blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|-
|[[name]]`name`|`String`|-
|===

[[EventOptions]]
== EventOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[node]]`node`|`String`|-
|[[payload]]`payload`|`String`|-
|[[service]]`service`|`String`|-
|[[tag]]`tag`|`String`|-
|===

[[KeyValue]]
== KeyValue


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[createIndex]]`createIndex`|`Number (long)`|-
|[[flags]]`flags`|`Number (long)`|-
|[[key]]`key`|`String`|-
|[[lockIndex]]`lockIndex`|`Number (long)`|-
|[[modifyIndex]]`modifyIndex`|`Number (long)`|-
|[[session]]`session`|`String`|-
|[[value]]`value`|`String`|-
|===

[[KeyValueList]]
== KeyValueList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#KeyValue[KeyValue]`|-
|===

[[KeyValueOptions]]
== KeyValueOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[acquireSession]]`acquireSession`|`String`|-
|[[casIndex]]`casIndex`|`Number (long)`|-
|[[flags]]`flags`|`Number (long)`|-
|[[releaseSession]]`releaseSession`|`String`|-
|===

[[MaintenanceOptions]]
== MaintenanceOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[enable]]`enable`|`Boolean`|-
|[[id]]`id`|`String`|-
|[[reason]]`reason`|`String`|-
|===

[[Node]]
== Node


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[address]]`address`|`String`|-
|[[lanAddress]]`lanAddress`|`String`|-
|[[name]]`name`|`String`|-
|[[wanAddress]]`wanAddress`|`String`|-
|===

[[NodeList]]
== NodeList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Node[Node]`|-
|===

[[NodeQueryOptions]]
== NodeQueryOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[blockingOptions]]`blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|-
|[[near]]`near`|`String`|-
|===

[[PreparedQueryDefinition]]
== PreparedQueryDefinition


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[dcs]]`dcs`|`Array of String`|-
|[[dnsTtl]]`dnsTtl`|`String`|-
|[[id]]`id`|`String`|-
|[[meta]]`meta`|`String`|-
|[[name]]`name`|`String`|-
|[[nearestN]]`nearestN`|`Number (int)`|-
|[[passing]]`passing`|`Boolean`|-
|[[service]]`service`|`String`|-
|[[session]]`session`|`String`|-
|[[tags]]`tags`|`Array of String`|-
|[[templateRegexp]]`templateRegexp`|`String`|-
|[[templateType]]`templateType`|`String`|-
|[[token]]`token`|`String`|-
|===

[[PreparedQueryExecuteOptions]]
== PreparedQueryExecuteOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[limit]]`limit`|`Number (int)`|-
|[[near]]`near`|`String`|-
|===

[[PreparedQueryExecuteResponse]]
== PreparedQueryExecuteResponse


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[dc]]`dc`|`String`|-
|[[dnsTtl]]`dnsTtl`|`String`|-
|[[failovers]]`failovers`|`Number (int)`|-
|[[nodes]]`nodes`|`Array of link:dataobjects.html#ServiceEntry[ServiceEntry]`|-
|[[service]]`service`|`String`|-
|===

[[Service]]
== Service


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[address]]`address`|`String`|-
|[[id]]`id`|`String`|-
|[[name]]`name`|`String`|-
|[[node]]`node`|`String`|-
|[[nodeAddress]]`nodeAddress`|`String`|-
|[[port]]`port`|`Number (int)`|-
|[[tags]]`tags`|`Array of String`|-
|===

[[ServiceEntry]]
== ServiceEntry


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[checks]]`checks`|`Array of link:dataobjects.html#Check[Check]`|-
|[[node]]`node`|`link:dataobjects.html#Node[Node]`|-
|[[service]]`service`|`link:dataobjects.html#Service[Service]`|-
|===

[[ServiceEntryList]]
== ServiceEntryList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#ServiceEntry[ServiceEntry]`|-
|===

[[ServiceList]]
== ServiceList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Service[Service]`|-
|===

[[ServiceOptions]]
== ServiceOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[address]]`address`|`String`|-
|[[checkOptions]]`checkOptions`|`link:dataobjects.html#CheckOptions[CheckOptions]`|-
|[[id]]`id`|`String`|-
|[[name]]`name`|`String`|-
|[[port]]`port`|`Number (int)`|-
|[[tags]]`tags`|`Array of String`|-
|===

[[ServiceQueryOptions]]
== ServiceQueryOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[blockingOptions]]`blockingOptions`|`link:dataobjects.html#BlockingQueryOptions[BlockingQueryOptions]`|-
|[[near]]`near`|`String`|-
|[[tag]]`tag`|`String`|-
|===

[[Session]]
== Session


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[checks]]`checks`|`Array of String`|-
|[[createIndex]]`createIndex`|`Number (long)`|-
|[[id]]`id`|`String`|-
|[[index]]`index`|`Number (long)`|-
|[[lockDelay]]`lockDelay`|`Number (long)`|-
|[[node]]`node`|`String`|-
|===

[[SessionList]]
== SessionList


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[index]]`index`|`Number (long)`|-
|[[list]]`list`|`Array of link:dataobjects.html#Session[Session]`|-
|===

[[SessionOptions]]
== SessionOptions


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[behavior]]`behavior`|`link:enums.html#SessionBehavior[SessionBehavior]`|-
|[[checks]]`checks`|`Array of String`|-
|[[lockDelay]]`lockDelay`|`Number (long)`|-
|[[name]]`name`|`String`|-
|[[node]]`node`|`String`|-
|[[ttl]]`ttl`|`Number (long)`|-
|===

[[TxnError]]
== TxnError


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[opIndex]]`opIndex`|`Number (int)`|-
|[[what]]`what`|`String`|-
|===

[[TxnKVOperation]]
== TxnKVOperation


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[flags]]`flags`|`Number (long)`|-
|[[index]]`index`|`Number (long)`|-
|[[key]]`key`|`String`|-
|[[session]]`session`|`String`|-
|[[type]]`type`|`link:enums.html#TxnKVVerb[TxnKVVerb]`|-
|[[value]]`value`|`String`|-
|===

[[TxnRequest]]
== TxnRequest


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[operationsSize]]`operationsSize`|`Number (int)`|-
|===

[[TxnResponse]]
== TxnResponse


[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[errors]]`errors`|`Array of link:dataobjects.html#TxnError[TxnError]`|-
|[[errorsSize]]`errorsSize`|`Number (int)`|-
|[[resultsSize]]`resultsSize`|`Number (int)`|-
|===