# Cheatsheets

## AclToken

Name | Type | Description
`id` | `String` | -
`name` | `String` | -
`rules` | `String` | -
`type` | `AclTokenType` | -

## BlockingQueryOptions

Name | Type | Description
`index` | `Number (long)` | -
`wait` | `String` | -

## Check

Name | Type | Description
`id` | `String` | -
`name` | `String` | -
`nodeName` | `String` | -
`notes` | `String` | -
`output` | `String` | -
`serviceId` | `String` | -
`serviceName` | `String` | -
`status` | `CheckStatus` | -

## CheckList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Check` | -

## CheckOptions

Name | Type | Description
`deregisterAfter` | `String` | -
`http` | `String` | -
`id` | `String` | -
`interval` | `String` | -
`name` | `String` | -
`notes` | `String` | -
`script` | `String` | -
`serviceId` | `String` | -
`status` | `CheckStatus` | -
`tcp` | `String` | -
`ttl` | `String` | -

## CheckQueryOptions

Name | Type | Description
`blockingOptions` | `BlockingQueryOptions` | -
`near` | `String` | -

## ConsulClientOptions

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

## Coordinate

Name | Type | Description
`adj` | `Number (float)` | -
`err` | `Number (float)` | -
`height` | `Number (float)` | -
`node` | `String` | -
`vec` | `Array of Number (Float)` | -

## CoordinateList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Coordinate` | -

## DcCoordinates

Name | Type | Description
`datacenter` | `String` | -
`servers` | `Array of Coordinate` | -

## Event

Name | Type | Description
`id` | `String` | -
`lTime` | `Number (int)` | -
`name` | `String` | -
`node` | `String` | -
`payload` | `String` | -
`service` | `String` | -
`tag` | `String` | -
`version` | `Number (int)` | -

## EventList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Event` | -

## EventListOptions

Name | Type | Description
`blockingOptions` | `BlockingQueryOptions` | -
`name` | `String` | -

## EventOptions

Name | Type | Description
`node` | `String` | -
`payload` | `String` | -
`service` | `String` | -
`tag` | `String` | -

## KeyValue

Name | Type | Description
`createIndex` | `Number (long)` | -
`flags` | `Number (long)` | -
`key` | `String` | -
`lockIndex` | `Number (long)` | -
`modifyIndex` | `Number (long)` | -
`session` | `String` | -
`value` | `String` | -

## KeyValueList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of KeyValue` | -

## KeyValueOptions

Name | Type | Description
`acquireSession` | `String` | -
`casIndex` | `Number (long)` | -
`flags` | `Number (long)` | -
`releaseSession` | `String` | -

## MaintenanceOptions

Name | Type | Description
`enable` | `Boolean` | -
`id` | `String` | -
`reason` | `String` | -

## Node

Name | Type | Description
`address` | `String` | -
`lanAddress` | `String` | -
`name` | `String` | -
`wanAddress` | `String` | -

## NodeList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Node` | -

## NodeQueryOptions

Name | Type | Description
`blockingOptions` | `BlockingQueryOptions` | -
`near` | `String` | -

## PreparedQueryDefinition

Name | Type | Description
`dcs` | `Array of String` | -
`dnsTtl` | `String` | -
`id` | `String` | -
`meta` | `String` | -
`name` | `String` | -
`nearestN` | `Number (int)` | -
`passing` | `Boolean` | -
`service` | `String` | -
`session` | `String` | -
`tags` | `Array of String` | -
`templateRegexp` | `String` | -
`templateType` | `String` | -
`token` | `String` | -

## PreparedQueryExecuteOptions

Name | Type | Description
`limit` | `Number (int)` | -
`near` | `String` | -

## PreparedQueryExecuteResponse

Name | Type | Description
`dc` | `String` | -
`dnsTtl` | `String` | -
`failovers` | `Number (int)` | -
`nodes` | `Array of ServiceEntry` | -
`service` | `String` | -

## Service

Name | Type | Description
`address` | `String` | -
`id` | `String` | -
`name` | `String` | -
`node` | `String` | -
`nodeAddress` | `String` | -
`port` | `Number (int)` | -
`tags` | `Array of String` | -

## ServiceEntry

Name | Type | Description
`checks` | `Array of Check` | -
`node` | `Node` | -
`service` | `Service` | -

## ServiceEntryList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of ServiceEntry` | -

## ServiceList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Service` | -

## ServiceOptions

Name | Type | Description
`address` | `String` | -
`checkOptions` | `CheckOptions` | -
`id` | `String` | -
`name` | `String` | -
`port` | `Number (int)` | -
`tags` | `Array of String` | -

## ServiceQueryOptions

Name | Type | Description
`blockingOptions` | `BlockingQueryOptions` | -
`near` | `String` | -
`tag` | `String` | -

## Session

Name | Type | Description
`checks` | `Array of String` | -
`createIndex` | `Number (long)` | -
`id` | `String` | -
`index` | `Number (long)` | -
`lockDelay` | `Number (long)` | -
`node` | `String` | -

## SessionList

Name | Type | Description
`index` | `Number (long)` | -
`list` | `Array of Session` | -

## SessionOptions

Name | Type | Description
`behavior` | `SessionBehavior` | -
`checks` | `Array of String` | -
`lockDelay` | `Number (long)` | -
`name` | `String` | -
`node` | `String` | -
`ttl` | `Number (long)` | -

## TxnError

Name | Type | Description
`opIndex` | `Number (int)` | -
`what` | `String` | -

## TxnKVOperation

Name | Type | Description
`flags` | `Number (long)` | -
`index` | `Number (long)` | -
`key` | `String` | -
`session` | `String` | -
`type` | `TxnKVVerb` | -
`value` | `String` | -

## TxnRequest

Name | Type | Description
`operationsSize` | `Number (int)` | -

## TxnResponse

Name | Type | Description
`errors` | `Array of TxnError` | -
`errorsSize` | `Number (int)` | -
`resultsSize` | `Number (int)` | -