ImmutableQueryOptions (consul-client 1.3.3 API)

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

All Implemented Interfaces:: ParamAdder

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableQueryOptions
extends QueryOptions

Immutable implementation of QueryOptions.

Use the builder to create immutable instances: ImmutableQueryOptions.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableQueryOptions.Builder
Builds instances of type ImmutableQueryOptions.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableQueryOptions.Builder` Builds instances of type `ImmutableQueryOptions`.

Field Summary
- Fields inherited from class com.orbitz.consul.option.QueryOptions
  BLANK

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableQueryOptions.Builder`	`builder()` Creates a builder for `ImmutableQueryOptions`.
`static ImmutableQueryOptions`	`copyOf(QueryOptions instance)` Creates an immutable copy of a `QueryOptions` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableQueryOptions` that have equal attribute values.
`ConsistencyMode`	`getConsistencyMode()`
`Optional<String>`	`getDatacenter()`
`Optional<BigInteger>`	`getIndex()`
`Optional<String>`	`getNear()`
`com.google.common.collect.ImmutableList<String>`	`getNodeMeta()`
`List<String>`	`getNodeMetaQuery()`
`com.google.common.collect.ImmutableList<String>`	`getTag()`
`List<String>`	`getTagsQuery()`
`Optional<String>`	`getToken()`
`Optional<String>`	`getWait()`
`int`	`hashCode()` Computes a hash code from attributes: `wait`, `token`, `index`, `near`, `datacenter`, `nodeMeta`, `tag`, `consistencyMode`, `isBlocking`, `hasToken`, `nodeMetaQuery`, `tagsQuery`.
`boolean`	`hasToken()`
`boolean`	`isBlocking()`
`String`	`toString()` Prints the immutable value `QueryOptions` with attribute values.
`ImmutableQueryOptions`	`withConsistencyMode(ConsistencyMode value)` Copy the current immutable object by setting a value for the `consistencyMode` attribute.
`ImmutableQueryOptions`	`withDatacenter(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `datacenter` attribute.
`ImmutableQueryOptions`	`withDatacenter(String value)` Copy the current immutable object by setting a present value for the optional `datacenter` attribute.
`ImmutableQueryOptions`	`withIndex(BigInteger value)` Copy the current immutable object by setting a present value for the optional `index` attribute.
`ImmutableQueryOptions`	`withIndex(Optional<? extends BigInteger> optional)` Copy the current immutable object by setting an optional value for the `index` attribute.
`ImmutableQueryOptions`	`withNear(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `near` attribute.
`ImmutableQueryOptions`	`withNear(String value)` Copy the current immutable object by setting a present value for the optional `near` attribute.
`ImmutableQueryOptions`	`withNodeMeta(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `nodeMeta`.
`ImmutableQueryOptions`	`withNodeMeta(String... elements)` Copy the current immutable object with elements that replace the content of `nodeMeta`.
`ImmutableQueryOptions`	`withTag(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `tag`.
`ImmutableQueryOptions`	`withTag(String... elements)` Copy the current immutable object with elements that replace the content of `tag`.
`ImmutableQueryOptions`	`withToken(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `token` attribute.
`ImmutableQueryOptions`	`withToken(String value)` Copy the current immutable object by setting a present value for the optional `token` attribute.
`ImmutableQueryOptions`	`withWait(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `wait` attribute.
`ImmutableQueryOptions`	`withWait(String value)` Copy the current immutable object by setting a present value for the optional `wait` attribute.

Methods inherited from class com.orbitz.consul.option.QueryOptions
blockMinutes, blockSeconds, toQuery

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

- Method Detail
  - getWait
```
public Optional<String> getWait()
```
    Specified by:
    
    getWait in class QueryOptions
    
    Returns:
    
    The value of the wait attribute
  - getToken
```
public Optional<String> getToken()
```
    Specified by:
    
    getToken in class QueryOptions
    
    Returns:
    
    The value of the token attribute
  - getIndex
```
public Optional<BigInteger> getIndex()
```
    Specified by:
    
    getIndex in class QueryOptions
    
    Returns:
    
    The value of the index attribute
  - getNear
```
public Optional<String> getNear()
```
    Specified by:
    
    getNear in class QueryOptions
    
    Returns:
    
    The value of the near attribute
  - getDatacenter
```
public Optional<String> getDatacenter()
```
    Specified by:
    
    getDatacenter in class QueryOptions
    
    Returns:
    
    The value of the datacenter attribute
  - getNodeMeta
```
public com.google.common.collect.ImmutableList<String> getNodeMeta()
```
    Specified by:
    
    getNodeMeta in class QueryOptions
    
    Returns:
    
    The value of the nodeMeta attribute
  - getTag
```
public com.google.common.collect.ImmutableList<String> getTag()
```
    Specified by:
    
    getTag in class QueryOptions
    
    Returns:
    
    The value of the tag attribute
  - getConsistencyMode
```
public ConsistencyMode getConsistencyMode()
```
    Overrides:
    
    getConsistencyMode in class QueryOptions
    
    Returns:
    
    The value of the consistencyMode attribute
  - isBlocking
```
public boolean isBlocking()
```
    Overrides:
    
    isBlocking in class QueryOptions
    
    Returns:
    
    The computed-at-construction value of the isBlocking attribute
  - hasToken
```
public boolean hasToken()
```
    Overrides:
    
    hasToken in class QueryOptions
    
    Returns:
    
    The computed-at-construction value of the hasToken attribute
  - getNodeMetaQuery
```
public List<String> getNodeMetaQuery()
```
    Overrides:
    
    getNodeMetaQuery in class QueryOptions
    
    Returns:
    
    The computed-at-construction value of the nodeMetaQuery attribute
  - getTagsQuery
```
public List<String> getTagsQuery()
```
    Overrides:
    
    getTagsQuery in class QueryOptions
    
    Returns:
    
    The computed-at-construction value of the tagsQuery attribute
  - withWait
```
public final ImmutableQueryOptions withWait(String value)
```
    Copy the current immutable object by setting a present value for the optional wait attribute.
    
    Parameters:
    
    value - The value for wait
    
    Returns:
    
    A modified copy of this object
  - withWait
```
public final ImmutableQueryOptions withWait(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the wait attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for wait
    
    Returns:
    
    A modified copy of this object
  - withToken
```
public final ImmutableQueryOptions withToken(String value)
```
    Copy the current immutable object by setting a present value for the optional token attribute.
    
    Parameters:
    
    value - The value for token
    
    Returns:
    
    A modified copy of this object
  - withToken
```
public final ImmutableQueryOptions withToken(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the token attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for token
    
    Returns:
    
    A modified copy of this object
  - withIndex
```
public final ImmutableQueryOptions withIndex(BigInteger value)
```
    Copy the current immutable object by setting a present value for the optional index attribute.
    
    Parameters:
    
    value - The value for index
    
    Returns:
    
    A modified copy of this object
  - withIndex
```
public final ImmutableQueryOptions withIndex(Optional<? extends BigInteger> optional)
```
    Copy the current immutable object by setting an optional value for the index attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for index
    
    Returns:
    
    A modified copy of this object
  - withNear
```
public final ImmutableQueryOptions withNear(String value)
```
    Copy the current immutable object by setting a present value for the optional near attribute.
    
    Parameters:
    
    value - The value for near
    
    Returns:
    
    A modified copy of this object
  - withNear
```
public final ImmutableQueryOptions withNear(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the near attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for near
    
    Returns:
    
    A modified copy of this object
  - withDatacenter
```
public final ImmutableQueryOptions withDatacenter(String value)
```
    Copy the current immutable object by setting a present value for the optional datacenter attribute.
    
    Parameters:
    
    value - The value for datacenter
    
    Returns:
    
    A modified copy of this object
  - withDatacenter
```
public final ImmutableQueryOptions withDatacenter(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the datacenter attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for datacenter
    
    Returns:
    
    A modified copy of this object
  - withNodeMeta
```
public final ImmutableQueryOptions withNodeMeta(String... elements)
```
    Copy the current immutable object with elements that replace the content of nodeMeta.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withNodeMeta
```
public final ImmutableQueryOptions withNodeMeta(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of nodeMeta. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of nodeMeta elements to set
    
    Returns:
    
    A modified copy of this object
  - withTag
```
public final ImmutableQueryOptions withTag(String... elements)
```
    Copy the current immutable object with elements that replace the content of tag.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withTag
```
public final ImmutableQueryOptions withTag(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of tag. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of tag elements to set
    
    Returns:
    
    A modified copy of this object
  - withConsistencyMode
```
public final ImmutableQueryOptions withConsistencyMode(ConsistencyMode value)
```
    Copy the current immutable object by setting a value for the consistencyMode attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for consistencyMode
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableQueryOptions that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: wait, token, index, near, datacenter, nodeMeta, tag, consistencyMode, isBlocking, hasToken, nodeMetaQuery, tagsQuery.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value QueryOptions with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableQueryOptions copyOf(QueryOptions instance)
```
    Creates an immutable copy of a QueryOptions value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable QueryOptions instance
  - builder
```
public static ImmutableQueryOptions.Builder builder()
```
    Creates a builder for ImmutableQueryOptions.
```
 ImmutableQueryOptions.builder()
    .wait(String) // optional wait
    .token(String) // optional token
    .index(java.math.BigInteger) // optional index
    .near(String) // optional near
    .datacenter(String) // optional datacenter
    .addNodeMeta|addAllNodeMeta(String) // nodeMeta elements
    .addTag|addAllTag(String) // tag elements
    .consistencyMode(com.orbitz.consul.option.ConsistencyMode) // optional consistencyMode
    .build();
 
```
    Returns:
    
    A new ImmutableQueryOptions builder

Class ImmutableQueryOptions

Nested Class Summary

Field Summary

Fields inherited from class com.orbitz.consul.option.QueryOptions

Method Summary

Methods inherited from class com.orbitz.consul.option.QueryOptions

Methods inherited from class java.lang.Object

Method Detail

getWait

getToken

getIndex

getNear

getDatacenter

getNodeMeta

getTag

getConsistencyMode

isBlocking

hasToken

getNodeMetaQuery

getTagsQuery

withWait

withWait

withToken

withToken

withIndex

withIndex

withNear

withNear

withDatacenter

withDatacenter

withNodeMeta

withNodeMeta

withTag

withTag

withConsistencyMode

equals

hashCode

toString

copyOf

builder