io.vertx.kotlin.ext.consul.BlockingQueryOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.ext.consul

import io.vertx.ext.consul.BlockingQueryOptions

/**
 * A function providing a DSL for building [io.vertx.ext.consul.BlockingQueryOptions] objects.
 *
 * Options used to perform blocking query that used to wait for a potential change using long polling.
 *
 * @param index  Set index indicating that the client wishes to wait for any changes subsequent to that index.
 * @param wait  Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.consul.BlockingQueryOptions original] using Vert.x codegen.
 */
fun blockingQueryOptionsOf(
  index: Long? = null,
  wait: String? = null): BlockingQueryOptions = io.vertx.ext.consul.BlockingQueryOptions().apply {

  if (index != null) {
    this.setIndex(index)
  }
  if (wait != null) {
    this.setWait(wait)
  }
}

/**
 * A function providing a DSL for building [io.vertx.ext.consul.BlockingQueryOptions] objects.
 *
 * Options used to perform blocking query that used to wait for a potential change using long polling.
 *
 * @param index  Set index indicating that the client wishes to wait for any changes subsequent to that index.
 * @param wait  Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.consul.BlockingQueryOptions original] using Vert.x codegen.
 */
@Deprecated(
  message = "This function will be removed in a future version",
  replaceWith = ReplaceWith("blockingQueryOptionsOf(index, wait)")
)
fun BlockingQueryOptions(
  index: Long? = null,
  wait: String? = null): BlockingQueryOptions = io.vertx.ext.consul.BlockingQueryOptions().apply {

  if (index != null) {
    this.setIndex(index)
  }
  if (wait != null) {
    this.setWait(wait)
  }
}