io.micronaut.discovery.eureka.client.v2

Interface EurekaOperations

All Known Subinterfaces:

EurekaClient

public interface EurekaOperations

API operations for Eureka. See https://github.com/Netflix/eureka/wiki/Eureka-REST-operations.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<HttpStatus>	deregister(@NotBlank java.lang.String appId, @NotBlank java.lang.String instanceId) De-registers a InstanceInfo with the Eureka server.
org.reactivestreams.Publisher<ApplicationInfo>	getApplicationInfo(@NotBlank java.lang.String appId) Obtain a ApplicationInfo for the given app id.
org.reactivestreams.Publisher<java.util.List<ApplicationInfo>>	getApplicationInfos() Obtain all of the ApplicationInfo registered with Eureka.
org.reactivestreams.Publisher<java.util.List<ApplicationInfo>>	getApplicationVips(java.lang.String vipAddress) Obtain all of the ApplicationInfo registered with Eureka under the given VIP address.
org.reactivestreams.Publisher<InstanceInfo>	getInstanceInfo(@NotBlank java.lang.String appId, @NotBlank java.lang.String instanceId) Obtain a InstanceInfo for the given app id.
org.reactivestreams.Publisher<HttpStatus>	heartbeat(@NotBlank java.lang.String appId, @NotBlank java.lang.String instanceId) Send an application heartbeat to Eureka.
org.reactivestreams.Publisher<HttpStatus>	register(@NotBlank java.lang.String appId, @Valid @NotNull InstanceInfo instance) Registers a new InstanceInfo with the Eureka server.
org.reactivestreams.Publisher<HttpStatus>	updateMetadata(@NotBlank java.lang.String appId, @NotBlank java.lang.String instanceId, @NotBlank java.lang.String key, @NotBlank java.lang.String value) Update application metadata value.
org.reactivestreams.Publisher<HttpStatus>	updateStatus(@NotBlank java.lang.String appId, @NotBlank java.lang.String instanceId, InstanceInfo.Status status) Update the application's status.

Method Detail

register

@Post(uri="/apps/{appId}",
      single=true)
 @Retryable(attempts="${eureka.client.registration.retry-count:10}",
           delay="${eureka.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<HttpStatus> register(@NotBlank
                                                                                                                                                                                                                                       @NotBlank java.lang.String appId,
                                                                                                                                                                                                                                       @Valid @NotNull @Body
                                                                                                                                                                                                                                       @Valid @NotNull InstanceInfo instance)

Registers a new InstanceInfo with the Eureka server.

Parameters:

appId - The application id

instance - The instance

Returns:

A status of HttpStatus.NO_CONTENT on success

deregister

@Delete(uri="/apps/{appId}/{instanceId}",
        single=true)
 @Retryable(attempts="${eureka.client.registration.retry-count:10}",
           delay="${eureka.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<HttpStatus> deregister(@NotBlank
                                                                                                                                                                                                                                                          @NotBlank java.lang.String appId,
                                                                                                                                                                                                                                                          @NotBlank
                                                                                                                                                                                                                                                          @NotBlank java.lang.String instanceId)

De-registers a InstanceInfo with the Eureka server.

Parameters:

appId - The application id

instanceId - The instance id (this is the value of InstanceInfo.getId())

Returns:

A status of HttpStatus.OK on success

getApplicationInfo

@Get(uri="/apps/{appId}",
     single=true)
org.reactivestreams.Publisher<ApplicationInfo> getApplicationInfo(@NotBlank
                                                                                                              @NotBlank java.lang.String appId)

Obtain a ApplicationInfo for the given app id.

Parameters:

appId - The app id

Returns:

The ApplicationInfo instance

getInstanceInfo

@Get(uri="/apps/{appId}/{instanceId}",
     single=true)
org.reactivestreams.Publisher<InstanceInfo> getInstanceInfo(@NotBlank
                                                                                                                     @NotBlank java.lang.String appId,
                                                                                                                     @NotBlank
                                                                                                                     @NotBlank java.lang.String instanceId)

Obtain a InstanceInfo for the given app id.

Parameters:

appId - The app id

instanceId - The instance id (this is the value of InstanceInfo.getId())

Returns:

The InstanceInfo instance

getApplicationInfos

org.reactivestreams.Publisher<java.util.List<ApplicationInfo>> getApplicationInfos()

Obtain all of the ApplicationInfo registered with Eureka.

Returns:

The ApplicationInfo instances

getApplicationVips

org.reactivestreams.Publisher<java.util.List<ApplicationInfo>> getApplicationVips(java.lang.String vipAddress)

Obtain all of the ApplicationInfo registered with Eureka under the given VIP address.

Parameters:

vipAddress - The InstanceInfo.vipAddress

Returns:

The ApplicationInfo instances

See Also:

InstanceInfo.vipAddress

heartbeat

@Put(uri="/apps/{appId}/{instanceId}",
     single=true)
org.reactivestreams.Publisher<HttpStatus> heartbeat(@NotBlank
                                                                                                             @NotBlank java.lang.String appId,
                                                                                                             @NotBlank
                                                                                                             @NotBlank java.lang.String instanceId)

Send an application heartbeat to Eureka.

Parameters:

appId - The application id

instanceId - The instance id

Returns:

A status of HttpStatus.OK on success

updateStatus

@Put(uri="/apps/{appId}/{instanceId}/status?value={status}",
     single=true)
org.reactivestreams.Publisher<HttpStatus> updateStatus(@NotBlank
                                                                                                                                      @NotBlank java.lang.String appId,
                                                                                                                                      @NotBlank
                                                                                                                                      @NotBlank java.lang.String instanceId,
                                                                                                                                      @NotNull
                                                                                                                                      InstanceInfo.Status status)

Update the application's status.

Parameters:

appId - The application id

instanceId - The instance id

status - The status to use

Returns:

A status of HttpStatus.OK on success

updateMetadata

@Put(uri="/apps/{appId}/{instanceId}/metadata?{key}={value}",
     single=true)
org.reactivestreams.Publisher<HttpStatus> updateMetadata(@NotBlank
                                                                                                                                         @NotBlank java.lang.String appId,
                                                                                                                                         @NotBlank
                                                                                                                                         @NotBlank java.lang.String instanceId,
                                                                                                                                         @NotBlank
                                                                                                                                         @NotBlank java.lang.String key,
                                                                                                                                         @NotBlank
                                                                                                                                         @NotBlank java.lang.String value)

Update application metadata value.

Parameters:

appId - The application id

instanceId - The instance id

key - The key to update

value - The value to update

Returns:

A status of HttpStatus.OK on success