io.micronaut.discovery.eureka.client.v2

Interface ConfigurableInstanceInfo

All Known Implementing Classes:

InstanceInfo

public interface ConfigurableInstanceInfo

Interface implemented by InstanceInfo modelling the data returned by the Eureka REST API.

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

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
@NotBlank String	getApp() The application name.
String	getAppGroupName() The application group name.
String	getAsgName()
@Min(value=1L) int	getCountryId() The country id.
@NotNull DataCenterInfo	getDataCenterInfo() The DataCenterInfo instance.
String	getHealthCheckUrl()
String	getHomePageUrl()
@NotBlank String	getHostName() The host name of the application instance.
String	getId() Returns the unique id of the instance.
@NotBlank String	getInstanceId() The instance id.
@NotBlank String	getIpAddr() The IP address of the instance.
LeaseInfo	getLeaseInfo() The LeaseInfo instance.
Map<String,String>	getMetadata()
int	getPort() The port of the application instance.
String	getSecureHealthCheckUrl()
int	getSecurePort() The secure port of the application instance.
String	getSecureVipAddress()
InstanceInfo.Status	getStatus()
String	getStatusPageUrl()
String	getVipAddress()
void	setAppGroupName(String appGroupName) Sets the application group name.
void	setAsgName(String asgName) Sets the Amazon auto scaling group name to use.
void	setCountryId(int countryId) Sets the country id.
void	setDataCenterInfo(DataCenterInfo dataCenterInfo) Sets the DataCenterInfo.
void	setHealthCheckUrl(String healthCheckUrl) Sets the health check URL.
void	setHomePageUrl(String homePageUrl) Sets the home page URL.
void	setInstanceId(String instanceId) Sets the instance ID.
void	setIpAddr(String ipAddr) Sets the IP address of the instance.
void	setLeaseInfo(LeaseInfo leaseInfo) Sets the LeaseInfo.
void	setPort(int port) Sets the port of the application instance.
void	setSecureHealthCheckUrl(String secureHealthCheckUrl) Sets the secure health check URL.
void	setSecurePort(int securePort) Sets the secure port of the application instance.
void	setSecureVipAddress(String secureVipAddress) Sets the Secure Virtual Host Address.
void	setStatus(InstanceInfo.Status status) Sets the application status.
void	setStatusPageUrl(String statusPageUrl) Sets the status page URL.
void	setVipAddress(String vipAddress) Sets the Virtual Host Address.

Method Detail

getHostName

@NotBlank
@NotBlank String getHostName()

The host name of the application instance.

Returns:

The hostname

getId

String getId()

Returns the unique id of the instance. (Note) now that id is set at creation time within the instanceProvider, why do the other checks? This is still necessary for backwards compatibility when upgrading in a deployment with multiple client versions (some with the change, some without).

Returns:

the unique id.

getPort

int getPort()

The port of the application instance.

Returns:

The port

setPort

void setPort(int port)

Sets the port of the application instance.

Parameters:

port - The port of the application instance

getSecurePort

int getSecurePort()

The secure port of the application instance.

Returns:

The secure port

setSecurePort

void setSecurePort(int securePort)

Sets the secure port of the application instance.

Parameters:

securePort - The secure port of the application instance

getApp

@NotBlank
@NotBlank String getApp()

The application name.

Returns:

The application name

getAppGroupName

String getAppGroupName()

The application group name.

Returns:

The application group name

setAppGroupName

void setAppGroupName(String appGroupName)

Sets the application group name.

Parameters:

appGroupName - The application group name

getInstanceId

@NotBlank
@NotBlank String getInstanceId()

The instance id.

Returns:

The instance id

setInstanceId

void setInstanceId(String instanceId)

Sets the instance ID.

Parameters:

instanceId - The instance ID

getCountryId

@Min(value=1L)
@Min(value=1L) int getCountryId()

The country id.

Returns:

The country id

setCountryId

void setCountryId(int countryId)

Sets the country id.

Parameters:

countryId - The country id

getIpAddr

@NotBlank
@NotBlank String getIpAddr()

The IP address of the instance.

Returns:

The IP address

setIpAddr

void setIpAddr(String ipAddr)

Sets the IP address of the instance.

Parameters:

ipAddr - The IP address of the instance

getStatus

@NotNull
InstanceInfo.Status getStatus()

Returns:

The application status

setStatus

void setStatus(InstanceInfo.Status status)

Sets the application status.

Parameters:

status - The application status

getDataCenterInfo

@NotNull
@NotNull DataCenterInfo getDataCenterInfo()

The DataCenterInfo instance.

Returns:

The data center info

setDataCenterInfo

void setDataCenterInfo(DataCenterInfo dataCenterInfo)

Sets the DataCenterInfo.

Parameters:

dataCenterInfo - The DataCenterInfo

getLeaseInfo

LeaseInfo getLeaseInfo()

The LeaseInfo instance.

Returns:

The lease info

setLeaseInfo

void setLeaseInfo(LeaseInfo leaseInfo)

Sets the LeaseInfo.

Parameters:

leaseInfo - The LeaseInfo

getMetadata

Map<String,String> getMetadata()

Returns:

The instance metadata

getStatusPageUrl

String getStatusPageUrl()

Returns:

The status page URL

setStatusPageUrl

void setStatusPageUrl(String statusPageUrl)

Sets the status page URL.

Parameters:

statusPageUrl - The status page URL

getHomePageUrl

String getHomePageUrl()

Returns:

The home page URL

setHomePageUrl

void setHomePageUrl(String homePageUrl)

Sets the home page URL.

Parameters:

homePageUrl - The home page URL

getHealthCheckUrl

String getHealthCheckUrl()

Returns:

The health check URL

setHealthCheckUrl

void setHealthCheckUrl(String healthCheckUrl)

Sets the health check URL.

Parameters:

healthCheckUrl - The health check URL

getVipAddress

String getVipAddress()

Returns:

The Virtual Host Address for this instance (defaults to the app name).

setVipAddress

void setVipAddress(String vipAddress)

Sets the Virtual Host Address.

Parameters:

vipAddress - The Virtual Host Address

getSecureVipAddress

String getSecureVipAddress()

Returns:

The Secure Virtual Host Address for this instance (defaults to the app name)

setSecureVipAddress

void setSecureVipAddress(String secureVipAddress)

Sets the Secure Virtual Host Address.

Parameters:

secureVipAddress - The Secure Virtual Host Address

getSecureHealthCheckUrl

String getSecureHealthCheckUrl()

Returns:

The secure health check URL

setSecureHealthCheckUrl

void setSecureHealthCheckUrl(String secureHealthCheckUrl)

Sets the secure health check URL.

Parameters:

secureHealthCheckUrl - The secure health check URL

getAsgName

String getAsgName()

Returns:

The amazon auto scaling group name

setAsgName

void setAsgName(String asgName)

Sets the Amazon auto scaling group name to use.

Parameters:

asgName - The Amazon auto scaling group name to use