Class ImmutableRoleOptions.Builder

java.lang.Object
org.kiwiproject.consul.option.ImmutableRoleOptions.Builder
Enclosing class:
ImmutableRoleOptions

public static final class ImmutableRoleOptions.Builder extends Object
Builds instances of type ImmutableRoleOptions. 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 Details

    • from

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder from(ParamAdder instance)
      Fill a builder with attribute values from the provided org.kiwiproject.consul.option.ParamAdder instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation
    • from

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder from(RoleOptions instance)
      Fill a builder with attribute values from the provided org.kiwiproject.consul.option.RoleOptions instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation
    • addToQueryParameters

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder addToQueryParameters(String element)
      Adds one element to toQueryParameters list.
      Parameters:
      element - A toQueryParameters element
      Returns:
      this builder for use in a chained invocation
    • addToQueryParameters

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder addToQueryParameters(String... elements)
      Adds elements to toQueryParameters list.
      Parameters:
      elements - An array of toQueryParameters elements
      Returns:
      this builder for use in a chained invocation
    • toQueryParameters

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder toQueryParameters(Iterable<String> elements)
      Sets or replaces all elements for toQueryParameters list.
      Parameters:
      elements - An iterable of toQueryParameters elements
      Returns:
      this builder for use in a chained invocation
    • addAllToQueryParameters

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder addAllToQueryParameters(Iterable<String> elements)
      Adds elements to toQueryParameters list.
      Parameters:
      elements - An iterable of toQueryParameters elements
      Returns:
      this builder for use in a chained invocation
    • putToHeaders

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder putToHeaders(String key, String value)
      Put one entry to the toHeaders map.
      Parameters:
      key - The key in the toHeaders map
      value - The associated value in the toHeaders map
      Returns:
      this builder for use in a chained invocation
    • putToHeaders

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder putToHeaders(Map.Entry<String,? extends String> entry)
      Put one entry to the toHeaders map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation
    • toHeaders

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder toHeaders(Map<String,? extends String> entries)
      Sets or replaces all mappings from the specified map as entries for the toHeaders map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the toHeaders map
      Returns:
      this builder for use in a chained invocation
    • putAllToHeaders

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder putAllToHeaders(Map<String,? extends String> entries)
      Put all mappings from the specified map as entries to toHeaders map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the toHeaders map
      Returns:
      this builder for use in a chained invocation
    • policy

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder policy(String policy)
      Initializes the optional value policy to policy.
      Parameters:
      policy - The value for policy
      Returns:
      this builder for chained invocation
    • policy

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder policy(Optional<String> policy)
      Initializes the optional value policy to policy.
      Parameters:
      policy - The value for policy
      Returns:
      this builder for use in a chained invocation
    • namespace

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder namespace(String namespace)
      Initializes the optional value namespace to namespace.
      Parameters:
      namespace - The value for namespace
      Returns:
      this builder for chained invocation
    • namespace

      @CanIgnoreReturnValue public final ImmutableRoleOptions.Builder namespace(Optional<String> namespace)
      Initializes the optional value namespace to namespace.
      Parameters:
      namespace - The value for namespace
      Returns:
      this builder for use in a chained invocation
    • build

      public ImmutableRoleOptions build()
      Builds a new ImmutableRoleOptions.
      Returns:
      An immutable instance of RoleOptions
      Throws:
      IllegalStateException - if any required attributes are missing