/*
 * 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;

Options used to perform blocking query that used to wait for a potential change using long polling.
Author:
Ruslan Sennov
See Also:
Blocking Queries documentation/**
 * Options used to perform blocking query that used to wait for a potential change using long polling.
 *
 * @author <a href="mailto:ruslan.sennov@gmail.com">Ruslan Sennov</a>
 * @see <a href="https://www.consul.io/docs/agent/http.html">Blocking Queries documentation</a>
 */
@DataObject(generateConverter = true)
public class BlockingQueryOptions {

  private long index;
  private String wait;

  
Default constructor
/**
   * Default constructor
   */
  public BlockingQueryOptions() {}

  
Copy constructor
Params:
options – the one to copy/**
   * Copy constructor
   *
   * @param options the one to copy
   */
  public BlockingQueryOptions(BlockingQueryOptions options) {
    this.index = options.index;
    this.wait = options.wait;
  }

  
Constructor from JSON
Params:
options – the JSON/**
   * Constructor from JSON
   *
   * @param options the JSON
   */
  public BlockingQueryOptions(JsonObject options) {
    BlockingQueryOptionsConverter.fromJson(options, this);
  }

  
Convert to JSON
Returns:
the JSON/**
   * Convert to JSON
   *
   * @return the JSON
   */
  public JsonObject toJson() {
    JsonObject jsonObject = new JsonObject();
    BlockingQueryOptionsConverter.toJson(this, jsonObject);
    return jsonObject;
  }

  
Get index
Returns:
the index/**
   * Get index
   *
   * @return the index
   */
  public long getIndex() {
    return index;
  }

  
Set index indicating that the client wishes to wait for any changes subsequent to that index.
Params:
index – the index
Returns:
reference to this, for fluency/**
   * Set index indicating that the client wishes to wait for any changes subsequent to that index.
   *
   * @param index the index
   * @return reference to this, for fluency
   */
  public BlockingQueryOptions setIndex(long index) {
    this.index = index;
    return this;
  }

  
Get wait period
Returns:
wait period/**
   * Get wait period
   *
   * @return wait period
   */
  public String getWait() {
    return 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).
Params:
wait – wait period
Returns:
reference to this, for fluency/**
   * 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).
   *
   * @param wait wait period
   * @return reference to this, for fluency
   */
  public BlockingQueryOptions setWait(String wait) {
    this.wait = wait;
    return this;
  }
}