Class ClientOptions

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class ClientOptions
    extends java.lang.Object
    implements java.lang.Cloneable
    Container Options for customizing the behavior of the Container
    • Constructor Summary

      Constructors 
      Constructor Description
      ClientOptions()
      Create a new ClientOptions instance with defaults set for all options.
      ClientOptions​(ClientOptions options)
      Create a new ClientOptions instance that copies the configuration from the specified source options.
    • Constructor Detail

      • ClientOptions

        public ClientOptions()
        Create a new ClientOptions instance with defaults set for all options.
      • ClientOptions

        public ClientOptions​(ClientOptions options)
        Create a new ClientOptions instance that copies the configuration from the specified source options.
        Parameters:
        options - The ClientOptions instance whose settings are to be copied into this one.
    • Method Detail

      • id

        public java.lang.String id()
        Returns:
        the ID configured the Container
      • id

        public ClientOptions id​(java.lang.String id)
        Sets the container ID that should be used when creating Connections
        Parameters:
        id - The container Id that should be assigned to container connections.
        Returns:
        this options class for chaining.
      • futureType

        public java.lang.String futureType()
        Returns:
        the configure future type to use for this client connection
      • futureType

        public ClientOptions futureType​(java.lang.String futureType)
        Sets the desired future type that the client connection should use when creating the futures used by the API. By default the client will select a Future implementation by itself however the user can override this selection here if desired.
        Parameters:
        futureType - The name of the future type to use.
        Returns:
        this options object for chaining.
      • clone

        public ClientOptions clone()
        Overrides:
        clone in class java.lang.Object