ImmutablePutOptions (consul-client 1.3.3 API)

java.lang.Object
- com.orbitz.consul.option.PutOptions
- - com.orbitz.consul.option.ImmutablePutOptions

All Implemented Interfaces:: ParamAdder

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

Immutable implementation of PutOptions.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutablePutOptions.Builder
Builds instances of type ImmutablePutOptions.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutablePutOptions.Builder`	`builder()` Creates a builder for `ImmutablePutOptions`.
`static ImmutablePutOptions`	`copyOf(PutOptions instance)` Creates an immutable copy of a `PutOptions` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutablePutOptions` that have equal attribute values.
`Optional<String>`	`getAcquire()`
`Optional<Long>`	`getCas()`
`Optional<String>`	`getDc()`
`Optional<String>`	`getRelease()`
`Optional<String>`	`getToken()`
`int`	`hashCode()` Computes a hash code from attributes: `cas`, `acquire`, `release`, `dc`, `token`.
`String`	`toString()` Prints the immutable value `PutOptions` with attribute values.
`ImmutablePutOptions`	`withAcquire(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `acquire` attribute.
`ImmutablePutOptions`	`withAcquire(String value)` Copy the current immutable object by setting a present value for the optional `acquire` attribute.
`ImmutablePutOptions`	`withCas(long value)` Copy the current immutable object by setting a present value for the optional `cas` attribute.
`ImmutablePutOptions`	`withCas(Optional<Long> optional)` Copy the current immutable object by setting an optional value for the `cas` attribute.
`ImmutablePutOptions`	`withDc(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `dc` attribute.
`ImmutablePutOptions`	`withDc(String value)` Copy the current immutable object by setting a present value for the optional `dc` attribute.
`ImmutablePutOptions`	`withRelease(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `release` attribute.
`ImmutablePutOptions`	`withRelease(String value)` Copy the current immutable object by setting a present value for the optional `release` attribute.
`ImmutablePutOptions`	`withToken(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `token` attribute.
`ImmutablePutOptions`	`withToken(String value)` Copy the current immutable object by setting a present value for the optional `token` attribute.

Methods inherited from class com.orbitz.consul.option.PutOptions
toQuery

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

- Method Detail
  - getCas
```
public Optional<Long> getCas()
```
    Specified by:
    
    getCas in class PutOptions
    
    Returns:
    
    The value of the cas attribute
  - getAcquire
```
public Optional<String> getAcquire()
```
    Specified by:
    
    getAcquire in class PutOptions
    
    Returns:
    
    The value of the acquire attribute
  - getRelease
```
public Optional<String> getRelease()
```
    Specified by:
    
    getRelease in class PutOptions
    
    Returns:
    
    The value of the release attribute
  - getDc
```
public Optional<String> getDc()
```
    Specified by:
    
    getDc in class PutOptions
    
    Returns:
    
    The value of the dc attribute
  - getToken
```
public Optional<String> getToken()
```
    Specified by:
    
    getToken in class PutOptions
    
    Returns:
    
    The value of the token attribute
  - withCas
```
public final ImmutablePutOptions withCas(long value)
```
    Copy the current immutable object by setting a present value for the optional cas attribute.
    
    Parameters:
    
    value - The value for cas
    
    Returns:
    
    A modified copy of this object
  - withCas
```
public final ImmutablePutOptions withCas(Optional<Long> optional)
```
    Copy the current immutable object by setting an optional value for the cas 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 cas
    
    Returns:
    
    A modified copy of this object
  - withAcquire
```
public final ImmutablePutOptions withAcquire(String value)
```
    Copy the current immutable object by setting a present value for the optional acquire attribute.
    
    Parameters:
    
    value - The value for acquire
    
    Returns:
    
    A modified copy of this object
  - withAcquire
```
public final ImmutablePutOptions withAcquire(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the acquire 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 acquire
    
    Returns:
    
    A modified copy of this object
  - withRelease
```
public final ImmutablePutOptions withRelease(String value)
```
    Copy the current immutable object by setting a present value for the optional release attribute.
    
    Parameters:
    
    value - The value for release
    
    Returns:
    
    A modified copy of this object
  - withRelease
```
public final ImmutablePutOptions withRelease(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the release 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 release
    
    Returns:
    
    A modified copy of this object
  - withDc
```
public final ImmutablePutOptions withDc(String value)
```
    Copy the current immutable object by setting a present value for the optional dc attribute.
    
    Parameters:
    
    value - The value for dc
    
    Returns:
    
    A modified copy of this object
  - withDc
```
public final ImmutablePutOptions withDc(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the dc 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 dc
    
    Returns:
    
    A modified copy of this object
  - withToken
```
public final ImmutablePutOptions 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 ImmutablePutOptions 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
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutablePutOptions 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: cas, acquire, release, dc, token.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value PutOptions with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutablePutOptions copyOf(PutOptions instance)
```
    Creates an immutable copy of a PutOptions 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 PutOptions instance
  - builder
```
public static ImmutablePutOptions.Builder builder()
```
    Creates a builder for ImmutablePutOptions.
```
 ImmutablePutOptions.builder()
    .cas(Long) // optional cas
    .acquire(String) // optional acquire
    .release(String) // optional release
    .dc(String) // optional dc
    .token(String) // optional token
    .build();
 
```
    Returns:
    
    A new ImmutablePutOptions builder

Class ImmutablePutOptions

Nested Class Summary

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getCas

getAcquire

getRelease

getDc

getToken

withCas

withCas

withAcquire

withAcquire

withRelease

withRelease

withDc

withDc

withToken

withToken

equals

hashCode

toString

copyOf

builder