io.vertx.kotlin.config.ConfigStoreOptions.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.config

import io.vertx.config.ConfigStoreOptions

/**
 * A function providing a DSL for building [io.vertx.config.ConfigStoreOptions] objects.
 *
 * Data object representing the configuration of a configuration store. This object describes the configuration of a
 * chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
 * retrieved configuration chunk, and you can also configures the store if it needs configuration to
 * retrieve the configuration chunk.
 *
 * @param config  Sets the configuration of the store
 * @param format  Sets the format of the configuration that is retrieved from the store.
 * @param optional  Sets whether or not the store is optional. When the configuration is retrieve, if an optional store returns a failure, the failure is ignored and an empty json object is used instead (for this store).
 * @param type  Sets the configuration type
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.config.ConfigStoreOptions original] using Vert.x codegen.
 */
fun configStoreOptionsOf(
  config: io.vertx.core.json.JsonObject? = null,
  format: String? = null,
  optional: Boolean? = null,
  type: String? = null): ConfigStoreOptions = io.vertx.config.ConfigStoreOptions().apply {

  if (config != null) {
    this.setConfig(config)
  }
  if (format != null) {
    this.setFormat(format)
  }
  if (optional != null) {
    this.setOptional(optional)
  }
  if (type != null) {
    this.setType(type)
  }
}

/**
 * A function providing a DSL for building [io.vertx.config.ConfigStoreOptions] objects.
 *
 * Data object representing the configuration of a configuration store. This object describes the configuration of a
 * chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
 * retrieved configuration chunk, and you can also configures the store if it needs configuration to
 * retrieve the configuration chunk.
 *
 * @param config  Sets the configuration of the store
 * @param format  Sets the format of the configuration that is retrieved from the store.
 * @param optional  Sets whether or not the store is optional. When the configuration is retrieve, if an optional store returns a failure, the failure is ignored and an empty json object is used instead (for this store).
 * @param type  Sets the configuration type
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.config.ConfigStoreOptions original] using Vert.x codegen.
 */
@Deprecated(
  message = "This function will be removed in a future version",
  replaceWith = ReplaceWith("configStoreOptionsOf(config, format, optional, type)")
)
fun ConfigStoreOptions(
  config: io.vertx.core.json.JsonObject? = null,
  format: String? = null,
  optional: Boolean? = null,
  type: String? = null): ConfigStoreOptions = io.vertx.config.ConfigStoreOptions().apply {

  if (config != null) {
    this.setConfig(config)
  }
  if (format != null) {
    this.setFormat(format)
  }
  if (optional != null) {
    this.setOptional(optional)
  }
  if (type != null) {
    this.setType(type)
  }
}