ImmutableQueryOptions.Builder (consul-client 1.3.3 API)

java.lang.Object
- com.orbitz.consul.option.ImmutableQueryOptions.Builder

Enclosing class:

ImmutableQueryOptions
```
@NotThreadSafe
public static final class ImmutableQueryOptions.Builder
extends Object
```
Builds instances of type ImmutableQueryOptions. Initialize attributes and then invoke the build() method to create an immutable instance.
Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmutableQueryOptions.Builder`	`addAllNodeMeta(Iterable<String> elements)` Adds elements to `nodeMeta` list.
`ImmutableQueryOptions.Builder`	`addAllTag(Iterable<String> elements)` Adds elements to `tag` list.
`ImmutableQueryOptions.Builder`	`addNodeMeta(String... elements)` Adds elements to `nodeMeta` list.
`ImmutableQueryOptions.Builder`	`addNodeMeta(String element)` Adds one element to `nodeMeta` list.
`ImmutableQueryOptions.Builder`	`addTag(String... elements)` Adds elements to `tag` list.
`ImmutableQueryOptions.Builder`	`addTag(String element)` Adds one element to `tag` list.
`ImmutableQueryOptions`	`build()` Builds a new `ImmutableQueryOptions`.
`ImmutableQueryOptions.Builder`	`consistencyMode(ConsistencyMode consistencyMode)` Initializes the value for the `consistencyMode` attribute.
`ImmutableQueryOptions.Builder`	`datacenter(Optional<String> datacenter)` Initializes the optional value `datacenter` to datacenter.
`ImmutableQueryOptions.Builder`	`datacenter(String datacenter)` Initializes the optional value `datacenter` to datacenter.
`ImmutableQueryOptions.Builder`	`from(QueryOptions instance)` Fill a builder with attribute values from the provided `QueryOptions` instance.
`ImmutableQueryOptions.Builder`	`index(BigInteger index)` Initializes the optional value `index` to index.
`ImmutableQueryOptions.Builder`	`index(Optional<? extends BigInteger> index)` Initializes the optional value `index` to index.
`ImmutableQueryOptions.Builder`	`near(Optional<String> near)` Initializes the optional value `near` to near.
`ImmutableQueryOptions.Builder`	`near(String near)` Initializes the optional value `near` to near.
`ImmutableQueryOptions.Builder`	`nodeMeta(Iterable<String> elements)` Sets or replaces all elements for `nodeMeta` list.
`ImmutableQueryOptions.Builder`	`tag(Iterable<String> elements)` Sets or replaces all elements for `tag` list.
`ImmutableQueryOptions.Builder`	`token(Optional<String> token)` Initializes the optional value `token` to token.
`ImmutableQueryOptions.Builder`	`token(String token)` Initializes the optional value `token` to token.
`ImmutableQueryOptions.Builder`	`wait(Optional<String> wait)` Initializes the optional value `wait` to wait.
`ImmutableQueryOptions.Builder`	`wait(String wait)` Initializes the optional value `wait` to wait.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder from(QueryOptions instance)
```
    Fill a builder with attribute values from the provided QueryOptions instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - wait
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder wait(String wait)
```
    Initializes the optional value wait to wait.
    
    Parameters:
    
    wait - The value for wait
    
    Returns:
    
    this builder for chained invocation
  - wait
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder wait(Optional<String> wait)
```
    Initializes the optional value wait to wait.
    
    Parameters:
    
    wait - The value for wait
    
    Returns:
    
    this builder for use in a chained invocation
  - token
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder token(String token)
```
    Initializes the optional value token to token.
    
    Parameters:
    
    token - The value for token
    
    Returns:
    
    this builder for chained invocation
  - token
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder token(Optional<String> token)
```
    Initializes the optional value token to token.
    
    Parameters:
    
    token - The value for token
    
    Returns:
    
    this builder for use in a chained invocation
  - index
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder index(BigInteger index)
```
    Initializes the optional value index to index.
    
    Parameters:
    
    index - The value for index
    
    Returns:
    
    this builder for chained invocation
  - index
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder index(Optional<? extends BigInteger> index)
```
    Initializes the optional value index to index.
    
    Parameters:
    
    index - The value for index
    
    Returns:
    
    this builder for use in a chained invocation
  - near
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder near(String near)
```
    Initializes the optional value near to near.
    
    Parameters:
    
    near - The value for near
    
    Returns:
    
    this builder for chained invocation
  - near
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder near(Optional<String> near)
```
    Initializes the optional value near to near.
    
    Parameters:
    
    near - The value for near
    
    Returns:
    
    this builder for use in a chained invocation
  - datacenter
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder datacenter(String datacenter)
```
    Initializes the optional value datacenter to datacenter.
    
    Parameters:
    
    datacenter - The value for datacenter
    
    Returns:
    
    this builder for chained invocation
  - datacenter
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder datacenter(Optional<String> datacenter)
```
    Initializes the optional value datacenter to datacenter.
    
    Parameters:
    
    datacenter - The value for datacenter
    
    Returns:
    
    this builder for use in a chained invocation
  - addNodeMeta
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addNodeMeta(String element)
```
    Adds one element to nodeMeta list.
    
    Parameters:
    
    element - A nodeMeta element
    
    Returns:
    
    this builder for use in a chained invocation
  - addNodeMeta
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addNodeMeta(String... elements)
```
    Adds elements to nodeMeta list.
    
    Parameters:
    
    elements - An array of nodeMeta elements
    
    Returns:
    
    this builder for use in a chained invocation
  - nodeMeta
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder nodeMeta(Iterable<String> elements)
```
    Sets or replaces all elements for nodeMeta list.
    
    Parameters:
    
    elements - An iterable of nodeMeta elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllNodeMeta
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addAllNodeMeta(Iterable<String> elements)
```
    Adds elements to nodeMeta list.
    
    Parameters:
    
    elements - An iterable of nodeMeta elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addTag
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addTag(String element)
```
    Adds one element to tag list.
    
    Parameters:
    
    element - A tag element
    
    Returns:
    
    this builder for use in a chained invocation
  - addTag
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addTag(String... elements)
```
    Adds elements to tag list.
    
    Parameters:
    
    elements - An array of tag elements
    
    Returns:
    
    this builder for use in a chained invocation
  - tag
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder tag(Iterable<String> elements)
```
    Sets or replaces all elements for tag list.
    
    Parameters:
    
    elements - An iterable of tag elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllTag
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder addAllTag(Iterable<String> elements)
```
    Adds elements to tag list.
    
    Parameters:
    
    elements - An iterable of tag elements
    
    Returns:
    
    this builder for use in a chained invocation
  - consistencyMode
```
@CanIgnoreReturnValue
public final ImmutableQueryOptions.Builder consistencyMode(ConsistencyMode consistencyMode)
```
    Initializes the value for the consistencyMode attribute.
    If not set, this attribute will have a default value as returned by the initializer of consistencyMode.
    
    Parameters:
    
    consistencyMode - The value for consistencyMode
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public ImmutableQueryOptions build()
```
    Builds a new ImmutableQueryOptions.
    
    Returns:
    
    An immutable instance of QueryOptions
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class ImmutableQueryOptions.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

wait

wait

token

token

index

index

near

near

datacenter

datacenter

addNodeMeta

addNodeMeta

nodeMeta

addAllNodeMeta

addTag

addTag

tag

addAllTag

consistencyMode

build