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

import io.vertx.ext.consul.policy.AclPolicy

/**
 * A function providing a DSL for building [io.vertx.ext.consul.policy.AclPolicy] objects.
 *
 * Holds properties of Acl policies
 *
 * @param name  Sets a name. Must be unique
 * @param description  Sets an optional free-form description that is human-readable.
 * @param rules  Sets a rules. The format of the Rules property is detailed in the ACL Rules documentation
 * @param datacenters  Sets an optional datacenters. By default, the policy is valid in all datacenters
 * @param namespace  Sets an optional namespace. Default value is ns URL query parameter or in the X-Consul-Namespace header, or 'default' namespace.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.consul.policy.AclPolicy original] using Vert.x codegen.
 */
fun aclPolicyOf(
  name: String? = null,
  description: String? = null,
  rules: String? = null,
  datacenters: Iterable? = null,
  namespace: String? = null): AclPolicy = io.vertx.ext.consul.policy.AclPolicy().apply {

  if (name != null) {
    this.setName(name)
  }
  if (description != null) {
    this.setDescription(description)
  }
  if (rules != null) {
    this.setRules(rules)
  }
  if (datacenters != null) {
    this.setDatacenters(datacenters.toList())
  }
  if (namespace != null) {
    this.setNamespace(namespace)
  }
}