vertx / io.vertx.kotlin.ext.consul / CheckOptions

# CheckOptions

`fun CheckOptions(deregisterAfter: String? = null, grpc: String? = null, grpcTls: Boolean? = null, http: String? = null, id: String? = null, interval: String? = null, name: String? = null, notes: String? = null, scriptArgs: Iterable<String>? = null, serviceId: String? = null, status: CheckStatus? = null, tcp: String? = null, tlsSkipVerify: Boolean? = null, ttl: String? = null): CheckOptions`

A function providing a DSL for building io.vertx.ext.consul.CheckOptions objects.

Options used to register checks in Consul.

### Parameters

`deregisterAfter` - Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. If a check is associated with a service and has the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service.

`grpc` - Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol. The state of the check will be updated at the given Interval by probing the configured endpoint. The endpoint must be represented as address:port/service

`grpcTls` - Specifies whether to use TLS for this gRPC health check. If TLS is enabled, then by default, a valid TLS certificate is expected. Certificate verification can be turned off by setting TLSSkipVerify to true.

`http` - Set HTTP address to check. Also you should set checking interval

`id` - Set check ID

`interval` - Set checking interval

`name` - Set check name. This is mandatory field

`notes` - Set check notes

`scriptArgs` - Set scriptArgs. Also you should set checking interval

`serviceId` - Set the service ID to associate the registered check with an existing service provided by the agent.

`status` - Set the check status to specify the initial state of the health check.

`tcp` - Set TCP address to check. Also you should set checking interval

`tlsSkipVerify` - Specifies if the certificate for an HTTPS check should not be verified.

`ttl` - Set Time to Live of check.