io.vertx.kotlin.ext.consul.KeyValueOptions.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.KeyValueOptions

/**
 * A function providing a DSL for building [io.vertx.ext.consul.KeyValueOptions] objects.
 *
 * Options used to put key/value pair to Consul.
 *
 * @param acquireSession  Set session ID for lock acquisition operation.
 * @param releaseSession  Set session ID for lock release operation.
 * @param flags  Set the flags. Flags is an value between 0 and 2⁶⁴-1 that can be attached to each entry. Clients can choose to use this however makes sense for their application.
 * @param casIndex  Set the Check-And-Set index. If the index is 0, Consul will only put the key if it does not already exist. If the index is non-zero, the key is only set if the index matches the ModifyIndex of that key.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.consul.KeyValueOptions original] using Vert.x codegen.
 */
fun keyValueOptionsOf(
  acquireSession: String? = null,
  releaseSession: String? = null,
  flags: Long? = null,
  casIndex: Long? = null): KeyValueOptions = io.vertx.ext.consul.KeyValueOptions().apply {

  if (acquireSession != null) {
    this.setAcquireSession(acquireSession)
  }
  if (releaseSession != null) {
    this.setReleaseSession(releaseSession)
  }
  if (flags != null) {
    this.setFlags(flags)
  }
  if (casIndex != null) {
    this.setCasIndex(casIndex)
  }
}