vertx / io.vertx.kotlin.ext.consul / maintenanceOptionsOf

# maintenanceOptionsOf

`fun maintenanceOptionsOf(enable: Boolean? = null, id: String? = null, reason: String? = null): MaintenanceOptions`

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

Options used to placing a given service into "maintenance mode". During maintenance mode, the service will be marked as unavailable and will not be present in DNS or API queries. Maintenance mode is persistent and will be automatically restored on agent restart.

### Parameters

`enable` - Set maintenance mode to enabled: true to enter maintenance mode or false to resume normal operation. This flag is required.

`id` - Set the ID of service. This field is required.

`reason` - Set the reason message. If provided, its value should be a text string explaining the reason for placing the service into maintenance mode. This is simply to aid human operators.