Class InstanceInfo

Namespace

Steeltoe.Discovery.Eureka.AppInfo

Assembly

Steeltoe.Discovery.Eureka.dll

Represents an application instance in Eureka server.

public sealed class InstanceInfo

Inheritance

object

InstanceInfo

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ActionType

Gets the type of action done on the instance in the server. Primarily used for updating deltas in the EurekaDiscoveryClient instance.

public ActionType? ActionType { get; init; }

Property Value

ActionType?

AppGroupName

public string? AppGroupName { get; init; }

Property Value

string

AppName

Gets the application name of the instance. This is mostly used in querying of instances.

public string AppName { get; }

Property Value

string

AutoScalingGroupName

Gets the AWS autoscaling group name for this instance.

public string? AutoScalingGroupName { get; init; }

Property Value

string

CountryId

public int? CountryId { get; init; }

Property Value

int?

DataCenterInfo

Gets the datacenter information for where this instance is running.

public DataCenterInfo DataCenterInfo { get; }

Property Value

DataCenterInfo

EffectiveStatus

Gets the (possibly overridden) instance status.

public InstanceStatus EffectiveStatus { get; }

Property Value

InstanceStatus

HealthCheckUrl

Gets the computed URL for health checks. Prefers secure when both ports are enabled.

public string? HealthCheckUrl { get; init; }

Property Value

string

HomePageUrl

Gets the computed URL for the home page. Prefers secure when both ports are enabled.

public string? HomePageUrl { get; init; }

Property Value

string

HostName

Gets the fully qualified hostname of this running instance. This is mostly used in constructing the URL for communicating with the instance.

public string HostName { get; }

Property Value

string

IPAddress

Gets the IP address of this running instance.

public string IPAddress { get; }

Property Value

string

InstanceId

Gets the ID that uniquely identifies this instance within a Eureka server.

public string InstanceId { get; }

Property Value

string

IsCoordinatingDiscoveryServer

Gets a value indicating whether this instance is the coordinating discovery server.

public bool? IsCoordinatingDiscoveryServer { get; init; }

Property Value

bool?

IsDirty

Gets a value indicating whether any state changed, so that EurekaDiscoveryClient re-registers on the next heartbeat.

public bool IsDirty { get; }

Property Value

bool

IsNonSecurePortEnabled

Gets a value indicating whether NonSecurePort is enabled.

public bool IsNonSecurePortEnabled { get; init; }

Property Value

bool

IsSecurePortEnabled

Gets a value indicating whether SecurePort is enabled.

public bool IsSecurePortEnabled { get; init; }

Property Value

bool

LastDirtyTimeUtc

Gets the time, in UTC, when this instance was last touched.

public DateTime? LastDirtyTimeUtc { get; init; }

Property Value

DateTime?

LastUpdatedTimeUtc

Gets the time, in UTC, when the instance status was last updated.

public DateTime? LastUpdatedTimeUtc { get; init; }

Property Value

DateTime?

LeaseInfo

Gets the lease information for this instance.

public LeaseInfo? LeaseInfo { get; init; }

Property Value

LeaseInfo

Metadata

Gets application-specific metadata on the instance.

public IReadOnlyDictionary<string, string?> Metadata { get; init; }

Property Value

IReadOnlyDictionary<string, string>

NonSecurePort

Gets the port number that is used to service requests.

public int NonSecurePort { get; init; }

Property Value

int

OverriddenStatus

Gets the status being overridden by some other external process. This is mostly used in putting an instance out of service to block traffic to it.

public InstanceStatus? OverriddenStatus { get; init; }

Property Value

InstanceStatus?

SecureHealthCheckUrl

Gets the computed URL for secure health checks. This is only available if the secure port is enabled.

public string? SecureHealthCheckUrl { get; init; }

Property Value

string

SecurePort

Gets the secure port number that is used to service requests.

public int SecurePort { get; init; }

Property Value

int

SecureVipAddress

Gets the Secure Virtual Internet Protocol address(es) for this instance. Multiple values can be specified as a comma-separated list. When using service discovery, virtual addresses are resolved into real addresses on outgoing HTTP requests.

public string? SecureVipAddress { get; init; }

Property Value

string

Sid

Gets the identity of this application instance (deprecated).

public string? Sid { get; init; }

Property Value

string

Status

Gets the status of the instance. The status Up means the instance is ready to service requests.

public InstanceStatus? Status { get; init; }

Property Value

InstanceStatus?

StatusPageUrl

Gets the computed URL for the status page. Prefers secure when both ports are enabled.

public string? StatusPageUrl { get; init; }

Property Value

string

VipAddress

Gets the Virtual Internet Protocol address(es) for this instance. Multiple values can be specified as a comma-separated list. When using service discovery, virtual addresses are resolved into real addresses on outgoing HTTP requests.

public string? VipAddress { get; init; }

Property Value

string

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.