/*
 * Copyright (c) 2016 The original author or authors
 *
 * 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.ext.consul;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;

import java.util.List;
import java.util.Map;

Options used to register service.
Author:Ruslan Sennov
/** * Options used to register service. * * @author <a href="mailto:ruslan.sennov@gmail.com">Ruslan Sennov</a> */
@DataObject(generateConverter = true) public class ServiceOptions { private String id; private String name; private List<String> tags; private String address; private Map<String, String> meta; private int port; private CheckOptions checkOptions;
Default constructor
/** * Default constructor */
public ServiceOptions() { }
Copy constructor
Params:
  • options – the one to copy
/** * Copy constructor * * @param options the one to copy */
public ServiceOptions(ServiceOptions options) { this.id = options.id; this.name = options.name; this.tags = options.tags; this.address = options.address; this.meta = options.meta; this.port = options.port; this.checkOptions = options.checkOptions; }
Constructor from JSON
Params:
  • options – the JSON
/** * Constructor from JSON * * @param options the JSON */
public ServiceOptions(JsonObject options) { ServiceOptionsConverter.fromJson(options, this); }
Convert to JSON
Returns:the JSON
/** * Convert to JSON * * @return the JSON */
public JsonObject toJson() { JsonObject jsonObject = new JsonObject(); ServiceOptionsConverter.toJson(this, jsonObject); return jsonObject; }
Get the ID of session
Returns:the ID of session
/** * Get the ID of session * * @return the ID of session */
public String getId() { return id; }
Set the ID of session
Params:
  • id – the ID of session
Returns:reference to this, for fluency
/** * Set the ID of session * * @param id the ID of session * @return reference to this, for fluency */
public ServiceOptions setId(String id) { this.id = id; return this; }
Get service name
Returns:service name
/** * Get service name * * @return service name */
public String getName() { return name; }
Set service name
Params:
  • name – service name
Returns:reference to this, for fluency
/** * Set service name * * @param name service name * @return reference to this, for fluency */
public ServiceOptions setName(String name) { this.name = name; return this; }
Get list of tags associated with service
Returns:list of tags
/** * Get list of tags associated with service * * @return list of tags */
public List<String> getTags() { return tags; }
Set list of tags associated with service
Params:
  • tags – list of tags
Returns:reference to this, for fluency
/** * Set list of tags associated with service * * @param tags list of tags * @return reference to this, for fluency */
public ServiceOptions setTags(List<String> tags) { this.tags = tags; return this; }
Get service address
Returns:service address
/** * Get service address * * @return service address */
public String getAddress() { return address; }
Set service address
Params:
  • address – service address
Returns:reference to this, for fluency
/** * Set service address * * @param address service address * @return reference to this, for fluency */
public ServiceOptions setAddress(String address) { this.address = address; return this; }
Get arbitrary KV metadata linked to the service instance.
Returns:arbitrary KV metadata
/** * Get arbitrary KV metadata linked to the service instance. * * @return arbitrary KV metadata */
public Map<String, String> getMeta() { return meta; }
Specifies arbitrary KV metadata linked to the service instance.
Params:
  • meta – arbitrary KV metadata
Returns:reference to this, for fluency
/** * Specifies arbitrary KV metadata linked to the service instance. * * @param meta arbitrary KV metadata * @return reference to this, for fluency */
public ServiceOptions setMeta(Map<String, String> meta) { this.meta = meta; return this; }
Get service port
Returns:service port
/** * Get service port * * @return service port */
public int getPort() { return port; }
Set service port
Params:
  • port – service port
Returns:reference to this, for fluency
/** * Set service port * * @param port service port * @return reference to this, for fluency */
public ServiceOptions setPort(int port) { this.port = port; return this; }
Get check options of service
Returns:check options
/** * Get check options of service * * @return check options */
public CheckOptions getCheckOptions() { return checkOptions; }
Set check options of service
Params:
  • checkOptions – check options
Returns:reference to this, for fluency
/** * Set check options of service * * @param checkOptions check options * @return reference to this, for fluency */
public ServiceOptions setCheckOptions(CheckOptions checkOptions) { this.checkOptions = checkOptions; return this; } }