Package io.vertx.rxjava3.ext.consul

Class ConsulClient

  • All Implemented Interfaces:
    RxDelegate
    public class ConsulClient
extends Object
implements RxDelegate
    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 io.reactivex.rxjava3.core.Single<JsonObject> agentInfo()
        Returns the configuration and member information of the local agent
        Returns:
        reference to this, for fluency

      • rxAgentInfo

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

      • coordinateNodes

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

      • rxCoordinateNodes

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

      • coordinateNodesWithOptions

        public io.reactivex.rxjava3.core.Single<CoordinateList> coordinateNodesWithOptions​(BlockingQueryOptions options)
        Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike coordinateNodes()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxCoordinateNodesWithOptions

        public io.reactivex.rxjava3.core.Single<CoordinateList> rxCoordinateNodesWithOptions​(BlockingQueryOptions options)
        Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike coordinateNodes()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • coordinateDatacenters

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

      • rxCoordinateDatacenters

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

      • getKeys

        public io.reactivex.rxjava3.core.Single<List<String>> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<String>> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<KeyValue> 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.rxjava3.core.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

      • getValueWithOptions

        public io.reactivex.rxjava3.core.Single<KeyValue> getValueWithOptions​(String key,
                                                                      BlockingQueryOptions options)
        Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike getValue(java.lang.String)
        Parameters:
        key - the key
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxGetValueWithOptions

        public io.reactivex.rxjava3.core.Single<KeyValue> rxGetValueWithOptions​(String key,
                                                                        BlockingQueryOptions options)
        Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike getValue(java.lang.String)
        Parameters:
        key - the key
        options - the blocking options
        Returns:
        reference to this, for fluency

      • deleteValue

        public io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<KeyValueList> 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.rxjava3.core.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

      • getValuesWithOptions

        public io.reactivex.rxjava3.core.Single<KeyValueList> getValuesWithOptions​(String keyPrefix,
                                                                           BlockingQueryOptions options)
        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. This is blocking query unlike getValues(java.lang.String)
        Parameters:
        keyPrefix - the prefix
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxGetValuesWithOptions

        public io.reactivex.rxjava3.core.Single<KeyValueList> rxGetValuesWithOptions​(String keyPrefix,
                                                                             BlockingQueryOptions options)
        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. This is blocking query unlike getValues(java.lang.String)
        Parameters:
        keyPrefix - the prefix
        options - the blocking options
        Returns:
        reference to this, for fluency

      • deleteValues

        public io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<Boolean> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<Boolean> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<TxnResponse> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<String> createAclPolicy​(AclPolicy policy)
        Creates a new ACL policy
        Parameters:
        policy - properties of policy
        Returns:
        reference to this, for fluency

      • rxCreateAclPolicy

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

      • readPolicy

        public io.reactivex.rxjava3.core.Single<AclPolicy> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<AclPolicy> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<AclPolicy> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<AclToken> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<AclToken> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<AclToken> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<AclToken>> getAclTokens()
        Get list of Acl token
        Returns:
        reference to this, for fluency

      • rxGetAclTokens

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

      • readAclToken

        public io.reactivex.rxjava3.core.Single<AclToken> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<Boolean> deleteAclToken​(String accessorId)
        Deletes an ACL token
        Parameters:
        accessorId - uuid of token
        Returns:
        reference to this, for fluency

      • rxDeleteAclToken

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

      • createAclToken

        @Deprecated
public io.reactivex.rxjava3.core.Single<String> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<String> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<String> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<AclToken>> listAclTokens()
        Deprecated.
        Get list of Acl token
        Returns:
        reference to this, for fluency

      • rxListAclTokens

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

      • infoAclToken

        @Deprecated
public io.reactivex.rxjava3.core.Single<AclToken> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable destroyAclToken​(String id)
        Deprecated.
        Destroy Acl token
        Parameters:
        id - the ID of token
        Returns:
        reference to this, for fluency

      • rxDestroyAclToken

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

      • fireEvent

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

      • rxFireEvent

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

      • fireEventWithOptions

        public io.reactivex.rxjava3.core.Single<Event> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<EventList> listEvents()
        Returns the most recent events known by the agent
        Returns:
        reference to this, for fluency

      • rxListEvents

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

      • listEventsWithOptions

        public io.reactivex.rxjava3.core.Single<EventList> listEventsWithOptions​(EventListOptions options)
        Returns the most recent events known by the agent. This is blocking query unlike listEvents(). 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.rxjava3.core.Single<EventList> rxListEventsWithOptions​(EventListOptions options)
        Returns the most recent events known by the agent. This is blocking query unlike listEvents(). 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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.Completable rxMaintenanceService​(MaintenanceOptions maintenanceOptions)
        Places a given service into "maintenance mode"
        Parameters:
        maintenanceOptions - the maintenance options
        Returns:
        reference to this, for fluency

      • deregisterService

        public io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<ServiceList> catalogServiceNodes​(String service)
        Returns the nodes providing a service
        Parameters:
        service - name of service
        Returns:
        reference to this, for fluency

      • rxCatalogServiceNodes

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

      • catalogServiceNodesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<String>> catalogDatacenters()
        Return all the datacenters that are known by the Consul server
        Returns:
        reference to this, for fluency

      • rxCatalogDatacenters

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

      • catalogNodes

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

      • rxCatalogNodes

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

      • catalogNodesWithOptions

        public io.reactivex.rxjava3.core.Single<NodeList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<CheckList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<CheckList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<CheckList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<CheckList> 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.rxjava3.core.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

      • healthServiceNodes

        public io.reactivex.rxjava3.core.Single<ServiceEntryList> healthServiceNodes​(String service,
                                                                             boolean passing)
        Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodes(java.lang.String) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
        Parameters:
        service - the service name
        passing - if true, filter results to only nodes with all checks in the passing state
        Returns:
        reference to this, for fluency

      • rxHealthServiceNodes

        public io.reactivex.rxjava3.core.Single<ServiceEntryList> rxHealthServiceNodes​(String service,
                                                                               boolean passing)
        Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodes(java.lang.String) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
        Parameters:
        service - the service name
        passing - if true, filter results to only nodes with all checks in the passing state
        Returns:
        reference to this, for fluency

      • healthServiceNodesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceEntryList> healthServiceNodesWithOptions​(String service,
                                                                                        boolean passing,
                                                                                        ServiceQueryOptions options)
        Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
        Parameters:
        service - the service name
        passing - if true, filter results to only nodes with all checks in the passing state
        options - options used to request services
        Returns:
        reference to this, for fluency

      • rxHealthServiceNodesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceEntryList> rxHealthServiceNodesWithOptions​(String service,
                                                                                          boolean passing,
                                                                                          ServiceQueryOptions options)
        Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
        Parameters:
        service - the service name
        passing - if true, filter results to only nodes with all checks in the passing state
        options - options used to request services
        Returns:
        reference to this, for fluency

      • healthNodesWithOptions

        public io.reactivex.rxjava3.core.Single<CheckList> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<ServiceList> catalogServices()
        Returns the services registered in a datacenter
        Returns:
        reference to this, for fluency

      • rxCatalogServices

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

      • catalogServicesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceList> catalogServicesWithOptions​(BlockingQueryOptions options)
        Returns the services registered in a datacenter This is blocking query unlike catalogServices()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxCatalogServicesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceList> rxCatalogServicesWithOptions​(BlockingQueryOptions options)
        Returns the services registered in a datacenter This is blocking query unlike catalogServices()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • catalogNodeServices

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

      • rxCatalogNodeServices

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

      • catalogNodeServicesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceList> catalogNodeServicesWithOptions​(String node,
                                                                                    BlockingQueryOptions options)
        Returns the node's registered services This is blocking query unlike catalogNodeServices(java.lang.String)
        Parameters:
        node - node name
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxCatalogNodeServicesWithOptions

        public io.reactivex.rxjava3.core.Single<ServiceList> rxCatalogNodeServicesWithOptions​(String node,
                                                                                      BlockingQueryOptions options)
        Returns the node's registered services This is blocking query unlike catalogNodeServices(java.lang.String)
        Parameters:
        node - node name
        options - the blocking options
        Returns:
        reference to this, for fluency

      • localServices

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

      • rxLocalServices

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

      • localChecks

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

      • rxLocalChecks

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

      • registerCheck

        public io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<String> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<String>> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<String> createSession()
        Initialize a new session
        Returns:
        reference to this, for fluency

      • rxCreateSession

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

      • createSessionWithOptions

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

      • rxCreateSessionWithOptions

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

      • infoSession

        public io.reactivex.rxjava3.core.Single<Session> 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.rxjava3.core.Single<Session> rxInfoSession​(String id)
        Returns the requested session information
        Parameters:
        id - the ID of requested session
        Returns:
        reference to this, for fluency

      • infoSessionWithOptions

        public io.reactivex.rxjava3.core.Single<Session> infoSessionWithOptions​(String id,
                                                                        BlockingQueryOptions options)
        Returns the requested session information This is blocking query unlike infoSession(java.lang.String)
        Parameters:
        id - the ID of requested session
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxInfoSessionWithOptions

        public io.reactivex.rxjava3.core.Single<Session> rxInfoSessionWithOptions​(String id,
                                                                          BlockingQueryOptions options)
        Returns the requested session information This is blocking query unlike infoSession(java.lang.String)
        Parameters:
        id - the ID of requested session
        options - the blocking options
        Returns:
        reference to this, for fluency

      • renewSession

        public io.reactivex.rxjava3.core.Single<Session> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<SessionList> listSessions()
        Returns the active sessions
        Returns:
        reference to this, for fluency

      • rxListSessions

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

      • listSessionsWithOptions

        public io.reactivex.rxjava3.core.Single<SessionList> listSessionsWithOptions​(BlockingQueryOptions options)
        Returns the active sessions This is blocking query unlike listSessions()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxListSessionsWithOptions

        public io.reactivex.rxjava3.core.Single<SessionList> rxListSessionsWithOptions​(BlockingQueryOptions options)
        Returns the active sessions This is blocking query unlike listSessions()
        Parameters:
        options - the blocking options
        Returns:
        reference to this, for fluency

      • listNodeSessions

        public io.reactivex.rxjava3.core.Single<SessionList> 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.rxjava3.core.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

      • listNodeSessionsWithOptions

        public io.reactivex.rxjava3.core.Single<SessionList> listNodeSessionsWithOptions​(String nodeId,
                                                                                 BlockingQueryOptions options)
        Returns the active sessions for a given node This is blocking query unlike listNodeSessions(java.lang.String)
        Parameters:
        nodeId - the ID of node
        options - the blocking options
        Returns:
        reference to this, for fluency

      • rxListNodeSessionsWithOptions

        public io.reactivex.rxjava3.core.Single<SessionList> rxListNodeSessionsWithOptions​(String nodeId,
                                                                                   BlockingQueryOptions options)
        Returns the active sessions for a given node This is blocking query unlike listNodeSessions(java.lang.String)
        Parameters:
        nodeId - the ID of node
        options - the blocking options
        Returns:
        reference to this, for fluency

      • destroySession

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

      • rxDestroySession

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

      • createPreparedQuery

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

      • rxCreatePreparedQuery

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

      • getPreparedQuery

        public io.reactivex.rxjava3.core.Single<PreparedQueryDefinition> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<List<PreparedQueryDefinition>> getAllPreparedQueries()
        Returns a list of all prepared queries.
        Returns:
        reference to this, for fluency

      • rxGetAllPreparedQueries

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

      • updatePreparedQuery

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

      • rxUpdatePreparedQuery

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

      • deletePreparedQuery

        public io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<PreparedQueryExecuteResponse> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Single<PreparedQueryExecuteResponse> 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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 io.reactivex.rxjava3.core.Completable 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.rxjava3.core.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