@@ -75,53 +75,78 @@ ObjectMapper getObjectMapper() {
7575 }
7676
7777 /**
78- * Registers a service to Consul Agent with service ID .
78+ * Registers a service to Consul Agent.
7979 *
8080 * @param serviceId a service ID that identifying a service
8181 * @param serviceName a service name to register
8282 * @param endpoint an endpoint of service to register
8383 * @param check a check for the service
8484 * @param tags tags for the service
85- * @return a {@link CompletableFuture} that will be completed with the registered service ID
85+ *
86+ * @return an HttpResponse representing the HTTP response from Consul
8687 */
8788 public HttpResponse register (String serviceId , String serviceName , Endpoint endpoint ,
8889 @ Nullable Check check , List <String > tags ) {
8990 return agentClient .register (serviceId , serviceName , endpoint .host (), endpoint .port (), check , tags );
9091 }
9192
9293 /**
93- * De-registers a service to Consul Agent.
94+ * De-registers a service from Consul Agent.
9495 *
9596 * @param serviceId a service ID that identifying a service
97+ *
98+ * @return an HttpResponse representing the HTTP response from Consul
9699 */
97100 public HttpResponse deregister (String serviceId ) {
98101 return agentClient .deregister (serviceId );
99102 }
100103
101104 /**
102- * Get registered endpoints with service name from Consul agent.
105+ * Retrieves the list of registered endpoints for the specified service name from the Consul agent.
106+ *
107+ * @param serviceName the name of the service whose endpoints are to be retrieved
108+ *
109+ * @return a {@link CompletableFuture} which provides a list of {@link Endpoint}s
103110 */
104111 public CompletableFuture <List <Endpoint >> endpoints (String serviceName ) {
105112 return endpoints (serviceName , null , null );
106113 }
107114
108115 /**
109- * Get registered endpoints with service name in datacenter from Consul agent.
116+ * Retrieves the list of registered endpoints for the specified service name and datacenter
117+ * from the Consul agent, optionally applying a filter.
118+ *
119+ * @param serviceName the name of the service whose endpoints are to be retrieved
120+ * @param datacenter the datacenter to query; if {@code null}, the default datacenter is used
121+ * @param filter a filter expression to apply; if {@code null}, no filtering is performed
122+ *
123+ * @return a {@link CompletableFuture} which provides a list of {@link Endpoint}s
110124 */
111125 public CompletableFuture <List <Endpoint >> endpoints (String serviceName , @ Nullable String datacenter ,
112126 @ Nullable String filter ) {
113127 return catalogClient .endpoints (serviceName , datacenter , filter );
114128 }
115129
116130 /**
117- * Returns the registered endpoints with the specified service name from Consul agent.
131+ * Retrieves the list of healthy endpoints for the specified service name from the Consul agent.
132+ *
133+ * @param serviceName the name of the service whose healthy endpoints are to be retrieved
134+ *
135+ * @return a {@link CompletableFuture} which provides a list of healthy {@link Endpoint}s
118136 */
119137 public CompletableFuture <List <Endpoint >> healthyEndpoints (String serviceName ) {
120138 return healthyEndpoints (serviceName , null , null );
121139 }
122140
123141 /**
124- * Returns the registered endpoints with the specified service name in datacenter from Consul agent.
142+ * Retrieves the list of healthy endpoints for the specified service name and datacenter
143+ * from the Consul agent, optionally applying a filter.
144+ *
145+ * @param serviceName the name of the service whose healthy endpoints are to be retrieved
146+ * @param datacenter the datacenter to query; if {@code null}, the default datacenter is used
147+ * @param filter a filter expression to apply; if {@code null}, no filtering is performed
148+ *
149+ * @return a {@link CompletableFuture} which provides a list of healthy {@link Endpoint}s
125150 */
126151 public CompletableFuture <List <Endpoint >> healthyEndpoints (String serviceName , @ Nullable String datacenter ,
127152 @ Nullable String filter ) {
0 commit comments