Class ConsulClient


  • public class ConsulClient
    extends Object
    A Vert.x service used to interact with Consul.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Constructor Detail

      • ConsulClient

        public ConsulClient​(ConsulClient delegate)
      • ConsulClient

        public ConsulClient​(Object delegate)
    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • create

        public static ConsulClient create​(Vertx vertx)
        Create a Consul client with default options.
        Parameters:
        vertx - the Vert.x instance
        Returns:
        the client
      • create

        public static ConsulClient create​(Vertx vertx,
                                          ConsulClientOptions options)
        Create a Consul client.
        Parameters:
        vertx - the Vert.x instance
        options - the options
        Returns:
        the client
      • agentInfo

        public ConsulClient agentInfo​(Handler<AsyncResult<JsonObject>> resultHandler)
        Returns the configuration and member information of the local agent
        Parameters:
        resultHandler - will be provided with the configuration and member information of the local agent
        Returns:
        reference to this, for fluency
      • agentInfo

        public ConsulClient agentInfo()
        Returns the configuration and member information of the local agent
        Returns:
        reference to this, for fluency
      • rxAgentInfo

        public io.reactivex.Single<JsonObject> rxAgentInfo()
        Returns the configuration and member information of the local agent
        Returns:
        reference to this, for fluency
      • coordinateNodes

        public ConsulClient coordinateNodes​(Handler<AsyncResult<CoordinateList>> resultHandler)
        Returns the LAN network coordinates for all nodes in a given DC
        Parameters:
        resultHandler - will be provided with network coordinates of nodes in datacenter
        Returns:
        reference to this, for fluency
      • coordinateNodes

        public ConsulClient coordinateNodes()
        Returns the LAN network coordinates for all nodes in a given DC
        Returns:
        reference to this, for fluency
      • rxCoordinateNodes

        public io.reactivex.Single<CoordinateList> rxCoordinateNodes()
        Returns the LAN network coordinates for all nodes in a given DC
        Returns:
        reference to this, for fluency
      • coordinateDatacenters

        public ConsulClient coordinateDatacenters​(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)
        Returns the WAN network coordinates for all Consul servers, organized by DCs
        Parameters:
        resultHandler - will be provided with network coordinates for all Consul servers
        Returns:
        reference to this, for fluency
      • coordinateDatacenters

        public ConsulClient coordinateDatacenters()
        Returns the WAN network coordinates for all Consul servers, organized by DCs
        Returns:
        reference to this, for fluency
      • rxCoordinateDatacenters

        public io.reactivex.Single<List<DcCoordinates>> rxCoordinateDatacenters()
        Returns the WAN network coordinates for all Consul servers, organized by DCs
        Returns:
        reference to this, for fluency
      • getKeys

        public ConsulClient getKeys​(String keyPrefix,
                                    Handler<AsyncResult<List<String>>> resultHandler)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        resultHandler - will be provided with keys list
        Returns:
        reference to this, for fluency
      • getKeys

        public ConsulClient getKeys​(String keyPrefix)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • rxGetKeys

        public io.reactivex.Single<List<String>> rxGetKeys​(String keyPrefix)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • getKeysWithOptions

        public ConsulClient getKeysWithOptions​(String keyPrefix,
                                               BlockingQueryOptions options,
                                               Handler<AsyncResult<List<String>>> resultHandler)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        options - the blocking options
        resultHandler - will be provided with keys list
        Returns:
        reference to this, for fluency
      • getKeysWithOptions

        public ConsulClient getKeysWithOptions​(String keyPrefix,
                                               BlockingQueryOptions options)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        options - the blocking options
        Returns:
        reference to this, for fluency
      • rxGetKeysWithOptions

        public io.reactivex.Single<List<String>> rxGetKeysWithOptions​(String keyPrefix,
                                                                      BlockingQueryOptions options)
        Returns the list of keys that corresponding to the specified key prefix.
        Parameters:
        keyPrefix - the prefix
        options - the blocking options
        Returns:
        reference to this, for fluency
      • getValue

        public ConsulClient getValue​(String key,
                                     Handler<AsyncResult<KeyValue>> resultHandler)
        Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.
        Parameters:
        key - the key
        resultHandler - will be provided with key/value pair
        Returns:
        reference to this, for fluency
      • getValue

        public ConsulClient getValue​(String key)
        Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.
        Parameters:
        key - the key
        Returns:
        reference to this, for fluency
      • rxGetValue

        public io.reactivex.Single<KeyValue> rxGetValue​(String key)
        Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.
        Parameters:
        key - the key
        Returns:
        reference to this, for fluency
      • deleteValue

        public ConsulClient deleteValue​(String key,
                                        Handler<AsyncResult<Void>> resultHandler)
        Remove the key/value pair that corresponding to the specified key
        Parameters:
        key - the key
        resultHandler - will be called on complete
        Returns:
        reference to this, for fluency
      • deleteValue

        public ConsulClient deleteValue​(String key)
        Remove the key/value pair that corresponding to the specified key
        Parameters:
        key - the key
        Returns:
        reference to this, for fluency
      • rxDeleteValue

        public io.reactivex.Completable rxDeleteValue​(String key)
        Remove the key/value pair that corresponding to the specified key
        Parameters:
        key - the key
        Returns:
        reference to this, for fluency
      • getValues

        public ConsulClient getValues​(String keyPrefix,
                                      Handler<AsyncResult<KeyValueList>> resultHandler)
        Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.
        Parameters:
        keyPrefix - the prefix
        resultHandler - will be provided with list of key/value pairs
        Returns:
        reference to this, for fluency
      • getValues

        public ConsulClient getValues​(String keyPrefix)
        Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • rxGetValues

        public io.reactivex.Single<KeyValueList> rxGetValues​(String keyPrefix)
        Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • deleteValues

        public ConsulClient deleteValues​(String keyPrefix,
                                         Handler<AsyncResult<Void>> resultHandler)
        Removes all the key/value pair that corresponding to the specified key prefix
        Parameters:
        keyPrefix - the prefix
        resultHandler - will be called on complete
        Returns:
        reference to this, for fluency
      • deleteValues

        public ConsulClient deleteValues​(String keyPrefix)
        Removes all the key/value pair that corresponding to the specified key prefix
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • rxDeleteValues

        public io.reactivex.Completable rxDeleteValues​(String keyPrefix)
        Removes all the key/value pair that corresponding to the specified key prefix
        Parameters:
        keyPrefix - the prefix
        Returns:
        reference to this, for fluency
      • putValue

        public ConsulClient putValue​(String key,
                                     String value,
                                     Handler<AsyncResult<Boolean>> resultHandler)
        Adds specified key/value pair
        Parameters:
        key - the key
        value - the value
        resultHandler - will be provided with success of operation
        Returns:
        reference to this, for fluency
      • putValue

        public ConsulClient putValue​(String key,
                                     String value)
        Adds specified key/value pair
        Parameters:
        key - the key
        value - the value
        Returns:
        reference to this, for fluency
      • rxPutValue

        public io.reactivex.Single<Boolean> rxPutValue​(String key,
                                                       String value)
        Adds specified key/value pair
        Parameters:
        key - the key
        value - the value
        Returns:
        reference to this, for fluency
      • putValueWithOptions

        public ConsulClient putValueWithOptions​(String key,
                                                String value,
                                                KeyValueOptions options,
                                                Handler<AsyncResult<Boolean>> resultHandler)
        Parameters:
        key - the key
        value - the value
        options - options used to push pair
        resultHandler - will be provided with success of operation
        Returns:
        reference to this, for fluency
      • putValueWithOptions

        public ConsulClient putValueWithOptions​(String key,
                                                String value,
                                                KeyValueOptions options)
        Parameters:
        key - the key
        value - the value
        options - options used to push pair
        Returns:
        reference to this, for fluency
      • rxPutValueWithOptions

        public io.reactivex.Single<Boolean> rxPutValueWithOptions​(String key,
                                                                  String value,
                                                                  KeyValueOptions options)
        Parameters:
        key - the key
        value - the value
        options - options used to push pair
        Returns:
        reference to this, for fluency
      • transaction

        public ConsulClient transaction​(TxnRequest request,
                                        Handler<AsyncResult<TxnResponse>> resultHandler)
        Manages multiple operations inside a single, atomic transaction.
        Parameters:
        request - transaction request
        resultHandler - will be provided with result of transaction
        Returns:
        reference to this, for fluency
      • transaction

        public ConsulClient transaction​(TxnRequest request)
        Manages multiple operations inside a single, atomic transaction.
        Parameters:
        request - transaction request
        Returns:
        reference to this, for fluency
      • rxTransaction

        public io.reactivex.Single<TxnResponse> rxTransaction​(TxnRequest request)
        Manages multiple operations inside a single, atomic transaction.
        Parameters:
        request - transaction request
        Returns:
        reference to this, for fluency
      • createAclPolicy

        public ConsulClient createAclPolicy​(AclPolicy policy,
                                            Handler<AsyncResult<String>> resultHandler)
        Creates a new ACL policy
        Parameters:
        policy - properties of policy
        resultHandler - will be provided with result of policy
        Returns:
        reference to this, for fluency
      • createAclPolicy

        public ConsulClient createAclPolicy​(AclPolicy policy)
        Creates a new ACL policy
        Parameters:
        policy - properties of policy
        Returns:
        reference to this, for fluency
      • rxCreateAclPolicy

        public io.reactivex.Single<String> rxCreateAclPolicy​(AclPolicy policy)
        Creates a new ACL policy
        Parameters:
        policy - properties of policy
        Returns:
        reference to this, for fluency
      • readPolicy

        public ConsulClient readPolicy​(String id,
                                       Handler<AsyncResult<AclPolicy>> resultHandler)
        This endpoint reads an ACL policy with the given ID
        Parameters:
        id - uuid policy
        resultHandler - will be provided with result of policy
        Returns:
        a reference to this, for fluency
      • readPolicy

        public ConsulClient readPolicy​(String id)
        This endpoint reads an ACL policy with the given ID
        Parameters:
        id - uuid policy
        Returns:
        a reference to this, for fluency
      • rxReadPolicy

        public io.reactivex.Single<AclPolicy> rxReadPolicy​(String id)
        This endpoint reads an ACL policy with the given ID
        Parameters:
        id - uuid policy
        Returns:
        a reference to this, for fluency
      • readPolicyByName

        public ConsulClient readPolicyByName​(String name,
                                             Handler<AsyncResult<AclPolicy>> resultHandler)
        This endpoint reads an ACL policy with the given name
        Parameters:
        name - unique name of created policy
        resultHandler - will be provided with result of policy
        Returns:
        a reference to this, for fluency
      • readPolicyByName

        public ConsulClient readPolicyByName​(String name)
        This endpoint reads an ACL policy with the given name
        Parameters:
        name - unique name of created policy
        Returns:
        a reference to this, for fluency
      • rxReadPolicyByName

        public io.reactivex.Single<AclPolicy> rxReadPolicyByName​(String name)
        This endpoint reads an ACL policy with the given name
        Parameters:
        name - unique name of created policy
        Returns:
        a reference to this, for fluency
      • updatePolicy

        public ConsulClient updatePolicy​(String id,
                                         AclPolicy policy,
                                         Handler<AsyncResult<AclPolicy>> resultHandler)
        This endpoint updates an existing ACL policy
        Parameters:
        id - uuid of existing policy
        policy - options that will be applied to the existing policy
        resultHandler - will be provided with result of policy
        Returns:
        a reference to this, for fluency
      • updatePolicy

        public ConsulClient updatePolicy​(String id,
                                         AclPolicy policy)
        This endpoint updates an existing ACL policy
        Parameters:
        id - uuid of existing policy
        policy - options that will be applied to the existing policy
        Returns:
        a reference to this, for fluency
      • rxUpdatePolicy

        public io.reactivex.Single<AclPolicy> rxUpdatePolicy​(String id,
                                                             AclPolicy policy)
        This endpoint updates an existing ACL policy
        Parameters:
        id - uuid of existing policy
        policy - options that will be applied to the existing policy
        Returns:
        a reference to this, for fluency
      • deletePolicy

        public ConsulClient deletePolicy​(String id,
                                         Handler<AsyncResult<Boolean>> resultHandler)
        This endpoint deletes an ACL policy
        Parameters:
        id - uuid of existing policy
        resultHandler - will be provided with result of policy deleting
        Returns:
        a reference to this, for fluency
      • getAclPolicies

        public ConsulClient getAclPolicies​(Handler<AsyncResult<List<AclPolicy>>> resultHandler)
        This endpoint lists all the ACL policies. Note - The policies rules are not included in the listing and must be retrieved by the policy reading endpoint
        Parameters:
        resultHandler - will be provided with result of policy deleting
        Returns:
        a reference to this, for fluency
      • createAclToken

        public ConsulClient createAclToken​(AclToken token,
                                           Handler<AsyncResult<AclToken>> resultHandler)
        Create an Acl token
        Parameters:
        token - properties of the token
        resultHandler - will be provided with result of token
        Returns:
        reference to this, for fluency AclToken accessorId - required in the URL path or JSON body for getting, updating and cloning token. AclToken secretId - using in ConsulClientOptions.
      • createAclToken

        public ConsulClient createAclToken​(AclToken token)
        Create an Acl token
        Parameters:
        token - properties of the token
        Returns:
        reference to this, for fluency AclToken accessorId - required in the URL path or JSON body for getting, updating and cloning token. AclToken secretId - using in ConsulClientOptions.
      • rxCreateAclToken

        public io.reactivex.Single<AclToken> rxCreateAclToken​(AclToken token)
        Create an Acl token
        Parameters:
        token - properties of the token
        Returns:
        reference to this, for fluency AclToken accessorId - required in the URL path or JSON body for getting, updating and cloning token. AclToken secretId - using in ConsulClientOptions.
      • updateAclToken

        public ConsulClient updateAclToken​(String accessorId,
                                           AclToken token,
                                           Handler<AsyncResult<AclToken>> resultHandler)
        Update an existing Acl token
        Parameters:
        accessorId - uuid of the token
        token - properties of the token
        resultHandler - will be provided with result of token
        Returns:
        reference to this, for fluency
      • updateAclToken

        public ConsulClient updateAclToken​(String accessorId,
                                           AclToken token)
        Update an existing Acl token
        Parameters:
        accessorId - uuid of the token
        token - properties of the token
        Returns:
        reference to this, for fluency
      • rxUpdateAclToken

        public io.reactivex.Single<AclToken> rxUpdateAclToken​(String accessorId,
                                                              AclToken token)
        Update an existing Acl token
        Parameters:
        accessorId - uuid of the token
        token - properties of the token
        Returns:
        reference to this, for fluency
      • cloneAclToken

        public ConsulClient cloneAclToken​(String accessorId,
                                          CloneAclTokenOptions cloneAclToken,
                                          Handler<AsyncResult<AclToken>> resultHandler)
        Clones an existing ACL token
        Parameters:
        accessorId - uuid of the token
        cloneAclToken - properties of cloned token
        resultHandler - will be provided with result of token
        Returns:
        reference to this, for fluency
      • cloneAclToken

        public ConsulClient cloneAclToken​(String accessorId,
                                          CloneAclTokenOptions cloneAclToken)
        Clones an existing ACL token
        Parameters:
        accessorId - uuid of the token
        cloneAclToken - properties of cloned token
        Returns:
        reference to this, for fluency
      • rxCloneAclToken

        public io.reactivex.Single<AclToken> rxCloneAclToken​(String accessorId,
                                                             CloneAclTokenOptions cloneAclToken)
        Clones an existing ACL token
        Parameters:
        accessorId - uuid of the token
        cloneAclToken - properties of cloned token
        Returns:
        reference to this, for fluency
      • getAclTokens

        public ConsulClient getAclTokens​(Handler<AsyncResult<List<AclToken>>> resultHandler)
        Get list of Acl token
        Parameters:
        resultHandler - will be provided with result of tokens
        Returns:
        reference to this, for fluency
      • getAclTokens

        public ConsulClient getAclTokens()
        Get list of Acl token
        Returns:
        reference to this, for fluency
      • rxGetAclTokens

        public io.reactivex.Single<List<AclToken>> rxGetAclTokens()
        Get list of Acl token
        Returns:
        reference to this, for fluency
      • readAclToken

        public ConsulClient readAclToken​(String accessorId,
                                         Handler<AsyncResult<AclToken>> resultHandler)
        Reads an ACL token with the given Accessor ID
        Parameters:
        accessorId - uuid of token
        resultHandler - will be provided with result of token
        Returns:
        reference to this, for fluency
      • readAclToken

        public ConsulClient readAclToken​(String accessorId)
        Reads an ACL token with the given Accessor ID
        Parameters:
        accessorId - uuid of token
        Returns:
        reference to this, for fluency
      • rxReadAclToken

        public io.reactivex.Single<AclToken> rxReadAclToken​(String accessorId)
        Reads an ACL token with the given Accessor ID
        Parameters:
        accessorId - uuid of token
        Returns:
        reference to this, for fluency
      • deleteAclToken

        public ConsulClient deleteAclToken​(String accessorId,
                                           Handler<AsyncResult<Boolean>> resultHandler)
        Deletes an ACL token
        Parameters:
        accessorId - uuid of token
        resultHandler - will be provided with result of token deleting
        Returns:
        reference to this, for fluency
      • deleteAclToken

        public ConsulClient deleteAclToken​(String accessorId)
        Deletes an ACL token
        Parameters:
        accessorId - uuid of token
        Returns:
        reference to this, for fluency
      • rxDeleteAclToken

        public io.reactivex.Single<Boolean> rxDeleteAclToken​(String accessorId)
        Deletes an ACL token
        Parameters:
        accessorId - uuid of token
        Returns:
        reference to this, for fluency
      • createAclToken

        @Deprecated
        public ConsulClient createAclToken​(AclToken token,
                                           Handler<AsyncResult<String>> idHandler)
        Deprecated.
        Legacy create new Acl token
        Parameters:
        token - properties of the token
        idHandler - will be provided with ID of created token
        Returns:
        reference to this, for fluency
      • createAclToken

        @Deprecated
        public ConsulClient createAclToken​(AclToken token)
        Deprecated.
        Legacy create new Acl token
        Parameters:
        token - properties of the token
        Returns:
        reference to this, for fluency
      • rxCreateAclToken

        @Deprecated
        public io.reactivex.Single<String> rxCreateAclToken​(AclToken token)
        Deprecated.
        Legacy create new Acl token
        Parameters:
        token - properties of the token
        Returns:
        reference to this, for fluency
      • updateAclToken

        @Deprecated
        public ConsulClient updateAclToken​(AclToken token,
                                           Handler<AsyncResult<String>> idHandler)
        Deprecated.
        Update Acl token
        Parameters:
        token - properties of the token to be updated
        idHandler - will be provided with ID of updated
        Returns:
        reference to this, for fluency
      • updateAclToken

        @Deprecated
        public ConsulClient updateAclToken​(AclToken token)
        Deprecated.
        Update Acl token
        Parameters:
        token - properties of the token to be updated
        Returns:
        reference to this, for fluency
      • rxUpdateAclToken

        @Deprecated
        public io.reactivex.Single<String> rxUpdateAclToken​(AclToken token)
        Deprecated.
        Update Acl token
        Parameters:
        token - properties of the token to be updated
        Returns:
        reference to this, for fluency
      • cloneAclToken

        @Deprecated
        public ConsulClient cloneAclToken​(String id,
                                          Handler<AsyncResult<String>> idHandler)
        Deprecated.
        Clone Acl token
        Parameters:
        id - the ID of token to be cloned
        idHandler - will be provided with ID of cloned token
        Returns:
        reference to this, for fluency
      • cloneAclToken

        @Deprecated
        public ConsulClient cloneAclToken​(String id)
        Deprecated.
        Clone Acl token
        Parameters:
        id - the ID of token to be cloned
        Returns:
        reference to this, for fluency
      • rxCloneAclToken

        @Deprecated
        public io.reactivex.Single<String> rxCloneAclToken​(String id)
        Deprecated.
        Clone Acl token
        Parameters:
        id - the ID of token to be cloned
        Returns:
        reference to this, for fluency
      • listAclTokens

        @Deprecated
        public ConsulClient listAclTokens()
        Deprecated.
        Get list of Acl token
        Returns:
        reference to this, for fluency
      • rxListAclTokens

        @Deprecated
        public io.reactivex.Single<List<AclToken>> rxListAclTokens()
        Deprecated.
        Get list of Acl token
        Returns:
        reference to this, for fluency
      • infoAclToken

        @Deprecated
        public ConsulClient infoAclToken​(String id)
        Deprecated.
        Get info of Acl token
        Parameters:
        id - the ID of token
        Returns:
        reference to this, for fluency
      • rxInfoAclToken

        @Deprecated
        public io.reactivex.Single<AclToken> rxInfoAclToken​(String id)
        Deprecated.
        Get info of Acl token
        Parameters:
        id - the ID of token
        Returns:
        reference to this, for fluency
      • destroyAclToken

        @Deprecated
        public ConsulClient destroyAclToken​(String id,
                                            Handler<AsyncResult<Void>> resultHandler)
        Deprecated.
        Destroy Acl token
        Parameters:
        id - the ID of token
        resultHandler - will be called on complete
        Returns:
        reference to this, for fluency
      • destroyAclToken

        @Deprecated
        public ConsulClient destroyAclToken​(String id)
        Deprecated.
        Destroy Acl token
        Parameters:
        id - the ID of token
        Returns:
        reference to this, for fluency
      • rxDestroyAclToken

        @Deprecated
        public io.reactivex.Completable rxDestroyAclToken​(String id)
        Deprecated.
        Destroy Acl token
        Parameters:
        id - the ID of token
        Returns:
        reference to this, for fluency
      • fireEvent

        public ConsulClient fireEvent​(String name,
                                      Handler<AsyncResult<Event>> resultHandler)
        Fires a new user event
        Parameters:
        name - name of event
        resultHandler - will be provided with properties of event
        Returns:
        reference to this, for fluency
      • fireEvent

        public ConsulClient fireEvent​(String name)
        Fires a new user event
        Parameters:
        name - name of event
        Returns:
        reference to this, for fluency
      • rxFireEvent

        public io.reactivex.Single<Event> rxFireEvent​(String name)
        Fires a new user event
        Parameters:
        name - name of event
        Returns:
        reference to this, for fluency
      • fireEventWithOptions

        public ConsulClient fireEventWithOptions​(String name,
                                                 EventOptions options,
                                                 Handler<AsyncResult<Event>> resultHandler)
        Fires a new user event
        Parameters:
        name - name of event
        options - options used to create event
        resultHandler - will be provided with properties of event
        Returns:
        reference to this, for fluency
      • fireEventWithOptions

        public ConsulClient fireEventWithOptions​(String name,
                                                 EventOptions options)
        Fires a new user event
        Parameters:
        name - name of event
        options - options used to create event
        Returns:
        reference to this, for fluency
      • rxFireEventWithOptions

        public io.reactivex.Single<Event> rxFireEventWithOptions​(String name,
                                                                 EventOptions options)
        Fires a new user event
        Parameters:
        name - name of event
        options - options used to create event
        Returns:
        reference to this, for fluency
      • listEvents

        public ConsulClient listEvents​(Handler<AsyncResult<EventList>> resultHandler)
        Returns the most recent events known by the agent
        Parameters:
        resultHandler - will be provided with list of events
        Returns:
        reference to this, for fluency
      • listEvents

        public ConsulClient listEvents()
        Returns the most recent events known by the agent
        Returns:
        reference to this, for fluency
      • rxListEvents

        public io.reactivex.Single<EventList> rxListEvents()
        Returns the most recent events known by the agent
        Returns:
        reference to this, for fluency
      • listEventsWithOptions

        public ConsulClient listEventsWithOptions​(EventListOptions options,
                                                  Handler<AsyncResult<EventList>> resultHandler)
        Returns the most recent events known by the agent. This is blocking query unlike listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>). However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.

        In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.

        Parameters:
        options - the blocking options
        resultHandler - will be provided with list of events
        Returns:
        reference to this, for fluency
      • listEventsWithOptions

        public ConsulClient listEventsWithOptions​(EventListOptions options)
        Returns the most recent events known by the agent. This is blocking query unlike listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>). However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.

        In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.

        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency
      • rxListEventsWithOptions

        public io.reactivex.Single<EventList> rxListEventsWithOptions​(EventListOptions options)
        Returns the most recent events known by the agent. This is blocking query unlike listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>). However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.

        In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.

        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency
      • registerService

        public ConsulClient registerService​(ServiceOptions serviceOptions,
                                            Handler<AsyncResult<Void>> resultHandler)
        Adds a new service, with an optional health check, to the local agent.
        Parameters:
        serviceOptions - the options of new service
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • registerService

        public ConsulClient registerService​(ServiceOptions serviceOptions)
        Adds a new service, with an optional health check, to the local agent.
        Parameters:
        serviceOptions - the options of new service
        Returns:
        reference to this, for fluency
      • rxRegisterService

        public io.reactivex.Completable rxRegisterService​(ServiceOptions serviceOptions)
        Adds a new service, with an optional health check, to the local agent.
        Parameters:
        serviceOptions - the options of new service
        Returns:
        reference to this, for fluency
      • maintenanceService

        public ConsulClient maintenanceService​(MaintenanceOptions maintenanceOptions,
                                               Handler<AsyncResult<Void>> resultHandler)
        Places a given service into "maintenance mode"
        Parameters:
        maintenanceOptions - the maintenance options
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • maintenanceService

        public ConsulClient maintenanceService​(MaintenanceOptions maintenanceOptions)
        Places a given service into "maintenance mode"
        Parameters:
        maintenanceOptions - the maintenance options
        Returns:
        reference to this, for fluency
      • rxMaintenanceService

        public io.reactivex.Completable rxMaintenanceService​(MaintenanceOptions maintenanceOptions)
        Places a given service into "maintenance mode"
        Parameters:
        maintenanceOptions - the maintenance options
        Returns:
        reference to this, for fluency
      • deregisterService

        public ConsulClient deregisterService​(String id,
                                              Handler<AsyncResult<Void>> resultHandler)
        Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.
        Parameters:
        id - the ID of service
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • deregisterService

        public ConsulClient deregisterService​(String id)
        Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.
        Parameters:
        id - the ID of service
        Returns:
        reference to this, for fluency
      • rxDeregisterService

        public io.reactivex.Completable rxDeregisterService​(String id)
        Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.
        Parameters:
        id - the ID of service
        Returns:
        reference to this, for fluency
      • catalogServiceNodes

        public ConsulClient catalogServiceNodes​(String service,
                                                Handler<AsyncResult<ServiceList>> resultHandler)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        resultHandler - will be provided with list of nodes providing given service
        Returns:
        reference to this, for fluency
      • catalogServiceNodes

        public ConsulClient catalogServiceNodes​(String service)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        Returns:
        reference to this, for fluency
      • rxCatalogServiceNodes

        public io.reactivex.Single<ServiceList> rxCatalogServiceNodes​(String service)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        Returns:
        reference to this, for fluency
      • catalogServiceNodesWithOptions

        public ConsulClient catalogServiceNodesWithOptions​(String service,
                                                           ServiceQueryOptions options,
                                                           Handler<AsyncResult<ServiceList>> resultHandler)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        options - options used to request services
        resultHandler - will be provided with list of nodes providing given service
        Returns:
        reference to this, for fluency
      • catalogServiceNodesWithOptions

        public ConsulClient catalogServiceNodesWithOptions​(String service,
                                                           ServiceQueryOptions options)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        options - options used to request services
        Returns:
        reference to this, for fluency
      • rxCatalogServiceNodesWithOptions

        public io.reactivex.Single<ServiceList> rxCatalogServiceNodesWithOptions​(String service,
                                                                                 ServiceQueryOptions options)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        options - options used to request services
        Returns:
        reference to this, for fluency
      • catalogDatacenters

        public ConsulClient catalogDatacenters​(Handler<AsyncResult<List<String>>> resultHandler)
        Return all the datacenters that are known by the Consul server
        Parameters:
        resultHandler - will be provided with list of datacenters
        Returns:
        reference to this, for fluency
      • catalogDatacenters

        public ConsulClient catalogDatacenters()
        Return all the datacenters that are known by the Consul server
        Returns:
        reference to this, for fluency
      • rxCatalogDatacenters

        public io.reactivex.Single<List<String>> rxCatalogDatacenters()
        Return all the datacenters that are known by the Consul server
        Returns:
        reference to this, for fluency
      • catalogNodes

        public ConsulClient catalogNodes​(Handler<AsyncResult<NodeList>> resultHandler)
        Returns the nodes registered in a datacenter
        Parameters:
        resultHandler - will be provided with list of nodes
        Returns:
        reference to this, for fluency
      • catalogNodes

        public ConsulClient catalogNodes()
        Returns the nodes registered in a datacenter
        Returns:
        reference to this, for fluency
      • rxCatalogNodes

        public io.reactivex.Single<NodeList> rxCatalogNodes()
        Returns the nodes registered in a datacenter
        Returns:
        reference to this, for fluency
      • catalogNodesWithOptions

        public ConsulClient catalogNodesWithOptions​(NodeQueryOptions options,
                                                    Handler<AsyncResult<NodeList>> resultHandler)
        Returns the nodes registered in a datacenter
        Parameters:
        options - options used to request nodes
        resultHandler - will be provided with list of nodes
        Returns:
        reference to this, for fluency
      • catalogNodesWithOptions

        public ConsulClient catalogNodesWithOptions​(NodeQueryOptions options)
        Returns the nodes registered in a datacenter
        Parameters:
        options - options used to request nodes
        Returns:
        reference to this, for fluency
      • rxCatalogNodesWithOptions

        public io.reactivex.Single<NodeList> rxCatalogNodesWithOptions​(NodeQueryOptions options)
        Returns the nodes registered in a datacenter
        Parameters:
        options - options used to request nodes
        Returns:
        reference to this, for fluency
      • healthChecks

        public ConsulClient healthChecks​(String service,
                                         Handler<AsyncResult<CheckList>> resultHandler)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        resultHandler - will be provided with list of checks
        Returns:
        reference to this, for fluency
      • healthChecks

        public ConsulClient healthChecks​(String service)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        Returns:
        reference to this, for fluency
      • rxHealthChecks

        public io.reactivex.Single<CheckList> rxHealthChecks​(String service)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        Returns:
        reference to this, for fluency
      • healthChecksWithOptions

        public ConsulClient healthChecksWithOptions​(String service,
                                                    CheckQueryOptions options,
                                                    Handler<AsyncResult<CheckList>> resultHandler)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        options - options used to request checks
        resultHandler - will be provided with list of checks
        Returns:
        reference to this, for fluency
      • healthChecksWithOptions

        public ConsulClient healthChecksWithOptions​(String service,
                                                    CheckQueryOptions options)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        options - options used to request checks
        Returns:
        reference to this, for fluency
      • rxHealthChecksWithOptions

        public io.reactivex.Single<CheckList> rxHealthChecksWithOptions​(String service,
                                                                        CheckQueryOptions options)
        Returns the checks associated with the service
        Parameters:
        service - the service name
        options - options used to request checks
        Returns:
        reference to this, for fluency
      • healthState

        public ConsulClient healthState​(HealthState healthState,
                                        Handler<AsyncResult<CheckList>> resultHandler)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        resultHandler - will be provided with list of checks
        Returns:
        reference to this, for fluency
      • healthState

        public ConsulClient healthState​(HealthState healthState)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        Returns:
        reference to this, for fluency
      • rxHealthState

        public io.reactivex.Single<CheckList> rxHealthState​(HealthState healthState)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        Returns:
        reference to this, for fluency
      • healthStateWithOptions

        public ConsulClient healthStateWithOptions​(HealthState healthState,
                                                   CheckQueryOptions options,
                                                   Handler<AsyncResult<CheckList>> resultHandler)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        options - options used to request checks
        resultHandler - will be provided with list of checks
        Returns:
        reference to this, for fluency
      • healthStateWithOptions

        public ConsulClient healthStateWithOptions​(HealthState healthState,
                                                   CheckQueryOptions options)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        options - options used to request checks
        Returns:
        reference to this, for fluency
      • rxHealthStateWithOptions

        public io.reactivex.Single<CheckList> rxHealthStateWithOptions​(HealthState healthState,
                                                                       CheckQueryOptions options)
        Returns the checks in the specified status
        Parameters:
        healthState - the health state
        options - options used to request checks
        Returns:
        reference to this, for fluency
      • healthNodesWithOptions

        public ConsulClient healthNodesWithOptions​(String node,
                                                   CheckQueryOptions options,
                                                   Handler<AsyncResult<CheckList>> resultHandler)
        Returns the checks specific to the node provided on the path.
        Parameters:
        node - the node name or ID
        options - options used to request node health checks
        resultHandler -
        Returns:
        a future provided with list of services
      • healthNodesWithOptions

        public ConsulClient healthNodesWithOptions​(String node,
                                                   CheckQueryOptions options)
        Returns the checks specific to the node provided on the path.
        Parameters:
        node - the node name or ID
        options - options used to request node health checks
        Returns:
        a future provided with list of services
      • rxHealthNodesWithOptions

        public io.reactivex.Single<CheckList> rxHealthNodesWithOptions​(String node,
                                                                       CheckQueryOptions options)
        Returns the checks specific to the node provided on the path.
        Parameters:
        node - the node name or ID
        options - options used to request node health checks
        Returns:
        a future provided with list of services
      • catalogServices

        public ConsulClient catalogServices​(Handler<AsyncResult<ServiceList>> resultHandler)
        Returns the services registered in a datacenter
        Parameters:
        resultHandler - will be provided with list of services
        Returns:
        reference to this, for fluency
      • catalogServices

        public ConsulClient catalogServices()
        Returns the services registered in a datacenter
        Returns:
        reference to this, for fluency
      • rxCatalogServices

        public io.reactivex.Single<ServiceList> rxCatalogServices()
        Returns the services registered in a datacenter
        Returns:
        reference to this, for fluency
      • catalogNodeServices

        public ConsulClient catalogNodeServices​(String node,
                                                Handler<AsyncResult<ServiceList>> resultHandler)
        Returns the node's registered services
        Parameters:
        node - node name
        resultHandler - will be provided with list of services
        Returns:
        reference to this, for fluency
      • catalogNodeServices

        public ConsulClient catalogNodeServices​(String node)
        Returns the node's registered services
        Parameters:
        node - node name
        Returns:
        reference to this, for fluency
      • rxCatalogNodeServices

        public io.reactivex.Single<ServiceList> rxCatalogNodeServices​(String node)
        Returns the node's registered services
        Parameters:
        node - node name
        Returns:
        reference to this, for fluency
      • localServices

        public ConsulClient localServices​(Handler<AsyncResult<List<Service>>> resultHandler)
        Returns list of services registered with the local agent.
        Parameters:
        resultHandler - will be provided with list of services
        Returns:
        reference to this, for fluency
      • localServices

        public ConsulClient localServices()
        Returns list of services registered with the local agent.
        Returns:
        reference to this, for fluency
      • rxLocalServices

        public io.reactivex.Single<List<Service>> rxLocalServices()
        Returns list of services registered with the local agent.
        Returns:
        reference to this, for fluency
      • localChecks

        public ConsulClient localChecks​(Handler<AsyncResult<List<Check>>> resultHandler)
        Return all the checks that are registered with the local agent.
        Parameters:
        resultHandler - will be provided with list of checks
        Returns:
        reference to this, for fluency
      • localChecks

        public ConsulClient localChecks()
        Return all the checks that are registered with the local agent.
        Returns:
        reference to this, for fluency
      • rxLocalChecks

        public io.reactivex.Single<List<Check>> rxLocalChecks()
        Return all the checks that are registered with the local agent.
        Returns:
        reference to this, for fluency
      • registerCheck

        public ConsulClient registerCheck​(CheckOptions checkOptions,
                                          Handler<AsyncResult<Void>> resultHandler)
        Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.
        Parameters:
        checkOptions - options used to register new check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • registerCheck

        public ConsulClient registerCheck​(CheckOptions checkOptions)
        Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.
        Parameters:
        checkOptions - options used to register new check
        Returns:
        reference to this, for fluency
      • rxRegisterCheck

        public io.reactivex.Completable rxRegisterCheck​(CheckOptions checkOptions)
        Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.
        Parameters:
        checkOptions - options used to register new check
        Returns:
        reference to this, for fluency
      • deregisterCheck

        public ConsulClient deregisterCheck​(String checkId,
                                            Handler<AsyncResult<Void>> resultHandler)
        Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.
        Parameters:
        checkId - the ID of check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • deregisterCheck

        public ConsulClient deregisterCheck​(String checkId)
        Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • rxDeregisterCheck

        public io.reactivex.Completable rxDeregisterCheck​(String checkId)
        Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • passCheck

        public ConsulClient passCheck​(String checkId,
                                      Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • passCheck

        public ConsulClient passCheck​(String checkId)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • rxPassCheck

        public io.reactivex.Completable rxPassCheck​(String checkId)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • passCheckWithNote

        public ConsulClient passCheckWithNote​(String checkId,
                                              String note,
                                              Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • passCheckWithNote

        public ConsulClient passCheckWithNote​(String checkId,
                                              String note)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • rxPassCheckWithNote

        public io.reactivex.Completable rxPassCheckWithNote​(String checkId,
                                                            String note)
        Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • warnCheck

        public ConsulClient warnCheck​(String checkId,
                                      Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • warnCheck

        public ConsulClient warnCheck​(String checkId)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • rxWarnCheck

        public io.reactivex.Completable rxWarnCheck​(String checkId)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • warnCheckWithNote

        public ConsulClient warnCheckWithNote​(String checkId,
                                              String note,
                                              Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • warnCheckWithNote

        public ConsulClient warnCheckWithNote​(String checkId,
                                              String note)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • rxWarnCheckWithNote

        public io.reactivex.Completable rxWarnCheckWithNote​(String checkId,
                                                            String note)
        Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • failCheck

        public ConsulClient failCheck​(String checkId,
                                      Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • failCheck

        public ConsulClient failCheck​(String checkId)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • rxFailCheck

        public io.reactivex.Completable rxFailCheck​(String checkId)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        Returns:
        reference to this, for fluency
      • failCheckWithNote

        public ConsulClient failCheckWithNote​(String checkId,
                                              String note,
                                              Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • failCheckWithNote

        public ConsulClient failCheckWithNote​(String checkId,
                                              String note)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • rxFailCheckWithNote

        public io.reactivex.Completable rxFailCheckWithNote​(String checkId,
                                                            String note)
        Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • updateCheck

        public ConsulClient updateCheck​(String checkId,
                                        CheckStatus status,
                                        Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • updateCheck

        public ConsulClient updateCheck​(String checkId,
                                        CheckStatus status)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        Returns:
        reference to this, for fluency
      • rxUpdateCheck

        public io.reactivex.Completable rxUpdateCheck​(String checkId,
                                                      CheckStatus status)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        Returns:
        reference to this, for fluency
      • updateCheckWithNote

        public ConsulClient updateCheckWithNote​(String checkId,
                                                CheckStatus status,
                                                String note,
                                                Handler<AsyncResult<Void>> resultHandler)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • updateCheckWithNote

        public ConsulClient updateCheckWithNote​(String checkId,
                                                CheckStatus status,
                                                String note)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • rxUpdateCheckWithNote

        public io.reactivex.Completable rxUpdateCheckWithNote​(String checkId,
                                                              CheckStatus status,
                                                              String note)
        Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
        Parameters:
        checkId - the ID of check
        status - new status of check
        note - specifies a human-readable message. This will be passed through to the check's Output field.
        Returns:
        reference to this, for fluency
      • leaderStatus

        public ConsulClient leaderStatus​(Handler<AsyncResult<String>> resultHandler)
        Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"
        Parameters:
        resultHandler - will be provided with address of cluster leader
        Returns:
        reference to this, for fluency
      • leaderStatus

        public ConsulClient leaderStatus()
        Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"
        Returns:
        reference to this, for fluency
      • rxLeaderStatus

        public io.reactivex.Single<String> rxLeaderStatus()
        Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"
        Returns:
        reference to this, for fluency
      • peersStatus

        public ConsulClient peersStatus​(Handler<AsyncResult<List<String>>> resultHandler)
        Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"
        Parameters:
        resultHandler - will be provided with list of peers
        Returns:
        reference to this, for fluency
      • peersStatus

        public ConsulClient peersStatus()
        Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"
        Returns:
        reference to this, for fluency
      • rxPeersStatus

        public io.reactivex.Single<List<String>> rxPeersStatus()
        Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"
        Returns:
        reference to this, for fluency
      • createSession

        public ConsulClient createSession​(Handler<AsyncResult<String>> idHandler)
        Initialize a new session
        Parameters:
        idHandler - will be provided with ID of new session
        Returns:
        reference to this, for fluency
      • createSession

        public ConsulClient createSession()
        Initialize a new session
        Returns:
        reference to this, for fluency
      • rxCreateSession

        public io.reactivex.Single<String> rxCreateSession()
        Initialize a new session
        Returns:
        reference to this, for fluency
      • createSessionWithOptions

        public ConsulClient createSessionWithOptions​(SessionOptions options,
                                                     Handler<AsyncResult<String>> idHandler)
        Initialize a new session
        Parameters:
        options - options used to create session
        idHandler - will be provided with ID of new session
        Returns:
        reference to this, for fluency
      • createSessionWithOptions

        public ConsulClient createSessionWithOptions​(SessionOptions options)
        Initialize a new session
        Parameters:
        options - options used to create session
        Returns:
        reference to this, for fluency
      • rxCreateSessionWithOptions

        public io.reactivex.Single<String> rxCreateSessionWithOptions​(SessionOptions options)
        Initialize a new session
        Parameters:
        options - options used to create session
        Returns:
        reference to this, for fluency
      • infoSession

        public ConsulClient infoSession​(String id,
                                        Handler<AsyncResult<Session>> resultHandler)
        Returns the requested session information
        Parameters:
        id - the ID of requested session
        resultHandler - will be provided with info of requested session
        Returns:
        reference to this, for fluency
      • infoSession

        public ConsulClient infoSession​(String id)
        Returns the requested session information
        Parameters:
        id - the ID of requested session
        Returns:
        reference to this, for fluency
      • rxInfoSession

        public io.reactivex.Single<Session> rxInfoSession​(String id)
        Returns the requested session information
        Parameters:
        id - the ID of requested session
        Returns:
        reference to this, for fluency
      • renewSession

        public ConsulClient renewSession​(String id,
                                         Handler<AsyncResult<Session>> resultHandler)
        Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL
        Parameters:
        id - the ID of session that should be renewed
        resultHandler - will be provided with info of renewed session
        Returns:
        reference to this, for fluency
      • renewSession

        public ConsulClient renewSession​(String id)
        Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL
        Parameters:
        id - the ID of session that should be renewed
        Returns:
        reference to this, for fluency
      • rxRenewSession

        public io.reactivex.Single<Session> rxRenewSession​(String id)
        Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL
        Parameters:
        id - the ID of session that should be renewed
        Returns:
        reference to this, for fluency
      • listSessions

        public ConsulClient listSessions​(Handler<AsyncResult<SessionList>> resultHandler)
        Returns the active sessions
        Parameters:
        resultHandler - will be provided with list of sessions
        Returns:
        reference to this, for fluency
      • listSessions

        public ConsulClient listSessions()
        Returns the active sessions
        Returns:
        reference to this, for fluency
      • rxListSessions

        public io.reactivex.Single<SessionList> rxListSessions()
        Returns the active sessions
        Returns:
        reference to this, for fluency
      • listNodeSessions

        public ConsulClient listNodeSessions​(String nodeId,
                                             Handler<AsyncResult<SessionList>> resultHandler)
        Returns the active sessions for a given node
        Parameters:
        nodeId - the ID of node
        resultHandler - will be provided with list of sessions
        Returns:
        reference to this, for fluency
      • listNodeSessions

        public ConsulClient listNodeSessions​(String nodeId)
        Returns the active sessions for a given node
        Parameters:
        nodeId - the ID of node
        Returns:
        reference to this, for fluency
      • rxListNodeSessions

        public io.reactivex.Single<SessionList> rxListNodeSessions​(String nodeId)
        Returns the active sessions for a given node
        Parameters:
        nodeId - the ID of node
        Returns:
        reference to this, for fluency
      • destroySession

        public ConsulClient destroySession​(String id,
                                           Handler<AsyncResult<Void>> resultHandler)
        Destroys the given session
        Parameters:
        id - the ID of session
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • destroySession

        public ConsulClient destroySession​(String id)
        Destroys the given session
        Parameters:
        id - the ID of session
        Returns:
        reference to this, for fluency
      • rxDestroySession

        public io.reactivex.Completable rxDestroySession​(String id)
        Destroys the given session
        Parameters:
        id - the ID of session
        Returns:
        reference to this, for fluency
      • createPreparedQuery

        public ConsulClient createPreparedQuery​(PreparedQueryDefinition definition,
                                                Handler<AsyncResult<String>> resultHandler)
        Parameters:
        definition - definition of the prepare query
        resultHandler - will be provided with id of created prepare query
        Returns:
        reference to this, for fluency
      • createPreparedQuery

        public ConsulClient createPreparedQuery​(PreparedQueryDefinition definition)
        Parameters:
        definition - definition of the prepare query
        Returns:
        reference to this, for fluency
      • rxCreatePreparedQuery

        public io.reactivex.Single<String> rxCreatePreparedQuery​(PreparedQueryDefinition definition)
        Parameters:
        definition - definition of the prepare query
        Returns:
        reference to this, for fluency
      • getPreparedQuery

        public ConsulClient getPreparedQuery​(String id,
                                             Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)
        Returns an existing prepared query
        Parameters:
        id - the id of the query to read
        resultHandler - will be provided with definition of the prepare query
        Returns:
        reference to this, for fluency
      • getPreparedQuery

        public ConsulClient getPreparedQuery​(String id)
        Returns an existing prepared query
        Parameters:
        id - the id of the query to read
        Returns:
        reference to this, for fluency
      • rxGetPreparedQuery

        public io.reactivex.Single<PreparedQueryDefinition> rxGetPreparedQuery​(String id)
        Returns an existing prepared query
        Parameters:
        id - the id of the query to read
        Returns:
        reference to this, for fluency
      • getAllPreparedQueries

        public ConsulClient getAllPreparedQueries​(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)
        Returns a list of all prepared queries.
        Parameters:
        resultHandler - will be provided with list of definitions of the all prepare queries
        Returns:
        reference to this, for fluency
      • getAllPreparedQueries

        public ConsulClient getAllPreparedQueries()
        Returns a list of all prepared queries.
        Returns:
        reference to this, for fluency
      • rxGetAllPreparedQueries

        public io.reactivex.Single<List<PreparedQueryDefinition>> rxGetAllPreparedQueries()
        Returns a list of all prepared queries.
        Returns:
        reference to this, for fluency
      • updatePreparedQuery

        public ConsulClient updatePreparedQuery​(PreparedQueryDefinition definition,
                                                Handler<AsyncResult<Void>> resultHandler)
        Parameters:
        definition - definition of the prepare query
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • updatePreparedQuery

        public ConsulClient updatePreparedQuery​(PreparedQueryDefinition definition)
        Parameters:
        definition - definition of the prepare query
        Returns:
        reference to this, for fluency
      • rxUpdatePreparedQuery

        public io.reactivex.Completable rxUpdatePreparedQuery​(PreparedQueryDefinition definition)
        Parameters:
        definition - definition of the prepare query
        Returns:
        reference to this, for fluency
      • deletePreparedQuery

        public ConsulClient deletePreparedQuery​(String id,
                                                Handler<AsyncResult<Void>> resultHandler)
        Deletes an existing prepared query
        Parameters:
        id - the id of the query to delete
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • deletePreparedQuery

        public ConsulClient deletePreparedQuery​(String id)
        Deletes an existing prepared query
        Parameters:
        id - the id of the query to delete
        Returns:
        reference to this, for fluency
      • rxDeletePreparedQuery

        public io.reactivex.Completable rxDeletePreparedQuery​(String id)
        Deletes an existing prepared query
        Parameters:
        id - the id of the query to delete
        Returns:
        reference to this, for fluency
      • executePreparedQuery

        public ConsulClient executePreparedQuery​(String query,
                                                 Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        resultHandler - will be provided with response
        Returns:
        reference to this, for fluency
      • executePreparedQuery

        public ConsulClient executePreparedQuery​(String query)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        Returns:
        reference to this, for fluency
      • rxExecutePreparedQuery

        public io.reactivex.Single<PreparedQueryExecuteResponse> rxExecutePreparedQuery​(String query)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        Returns:
        reference to this, for fluency
      • executePreparedQueryWithOptions

        public ConsulClient executePreparedQueryWithOptions​(String query,
                                                            PreparedQueryExecuteOptions options,
                                                            Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        options - the options used to execute prepared query
        resultHandler - will be provided with response
        Returns:
        reference to this, for fluency
      • executePreparedQueryWithOptions

        public ConsulClient executePreparedQueryWithOptions​(String query,
                                                            PreparedQueryExecuteOptions options)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        options - the options used to execute prepared query
        Returns:
        reference to this, for fluency
      • rxExecutePreparedQueryWithOptions

        public io.reactivex.Single<PreparedQueryExecuteResponse> rxExecutePreparedQueryWithOptions​(String query,
                                                                                                   PreparedQueryExecuteOptions options)
        Executes an existing prepared query.
        Parameters:
        query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
        options - the options used to execute prepared query
        Returns:
        reference to this, for fluency
      • registerCatalogService

        public ConsulClient registerCatalogService​(Node nodeOptions,
                                                   ServiceOptions serviceOptions,
                                                   Handler<AsyncResult<Void>> resultHandler)
        Register node with external service
        Parameters:
        nodeOptions - the options of new node
        serviceOptions - the options of new service
        resultHandler - will be provided with response
        Returns:
        reference to this, for fluency
      • registerCatalogService

        public ConsulClient registerCatalogService​(Node nodeOptions,
                                                   ServiceOptions serviceOptions)
        Register node with external service
        Parameters:
        nodeOptions - the options of new node
        serviceOptions - the options of new service
        Returns:
        reference to this, for fluency
      • rxRegisterCatalogService

        public io.reactivex.Completable rxRegisterCatalogService​(Node nodeOptions,
                                                                 ServiceOptions serviceOptions)
        Register node with external service
        Parameters:
        nodeOptions - the options of new node
        serviceOptions - the options of new service
        Returns:
        reference to this, for fluency
      • deregisterCatalogService

        public ConsulClient deregisterCatalogService​(String nodeId,
                                                     String serviceId,
                                                     Handler<AsyncResult<Void>> resultHandler)
        Deregister entities from the node or deregister the node itself.
        Parameters:
        nodeId - the ID of node
        serviceId - the ID of the service to de-registered; if it is null, the node itself will be de-registered (as well as the entities that belongs to that node)
        resultHandler - will be called when complete
        Returns:
        reference to this, for fluency
      • deregisterCatalogService

        public ConsulClient deregisterCatalogService​(String nodeId,
                                                     String serviceId)
        Deregister entities from the node or deregister the node itself.
        Parameters:
        nodeId - the ID of node
        serviceId - the ID of the service to de-registered; if it is null, the node itself will be de-registered (as well as the entities that belongs to that node)
        Returns:
        reference to this, for fluency
      • rxDeregisterCatalogService

        public io.reactivex.Completable rxDeregisterCatalogService​(String nodeId,
                                                                   String serviceId)
        Deregister entities from the node or deregister the node itself.
        Parameters:
        nodeId - the ID of node
        serviceId - the ID of the service to de-registered; if it is null, the node itself will be de-registered (as well as the entities that belongs to that node)
        Returns:
        reference to this, for fluency
      • close

        public void close()
        Close the client and release its resources