Class ApplicationInstanceInfo

Namespace

Steeltoe.Common

Assembly

Steeltoe.Common.dll

public class ApplicationInstanceInfo : AbstractOptions, IApplicationInstanceInfo

Inheritance

object

AbstractOptions

ApplicationInstanceInfo

Implements

IApplicationInstanceInfo

Derived

KubernetesApplicationOptions

CloudFoundryApplicationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ApplicationInstanceInfo()

public ApplicationInstanceInfo()

ApplicationInstanceInfo(IConfiguration)

public ApplicationInstanceInfo(IConfiguration configuration)

Parameters

configuration IConfiguration

ApplicationInstanceInfo(IConfiguration, bool)

public ApplicationInstanceInfo(IConfiguration configuration, bool noPrefix)

Parameters

configuration IConfiguration

noPrefix bool

ApplicationInstanceInfo(IConfiguration, string)

public ApplicationInstanceInfo(IConfiguration configuration, string configPrefix)

Parameters

configuration IConfiguration

configPrefix string

Fields

ApplicationRoot

public static readonly string ApplicationRoot

Field Value

string

ConfigServerRoot

public readonly string ConfigServerRoot

Field Value

string

ConsulRoot

public readonly string ConsulRoot

Field Value

string

EurekaRoot

public readonly string EurekaRoot

Field Value

string

KubernetesRoot

public readonly string KubernetesRoot

Field Value

string

ManagementRoot

public readonly string ManagementRoot

Field Value

string

ServicesRoot

public readonly string ServicesRoot

Field Value

string

SpringApplicationRoot

public readonly string SpringApplicationRoot

Field Value

string

configuration

protected IConfiguration configuration

Field Value

IConfiguration

Properties

AppInstanceIdKey

public string AppInstanceIdKey { get; }

Property Value

string

AppNameKey

public string AppNameKey { get; }

Property Value

string

ApplicationId

Gets a GUID identifying the application

public virtual string ApplicationId { get; set; }

Property Value

string

ApplicationName

Gets the name of the application, as known to the hosting platform

public virtual string ApplicationName { get; }

Property Value

string

ApplicationVersion

public virtual string ApplicationVersion { get; set; }

Property Value

string

Application_Id

public string Application_Id { get; set; }

Property Value

string

ConfigServerNameKey

public string ConfigServerNameKey { get; }

Property Value

string

ConsulInstanceNameKey

public string ConsulInstanceNameKey { get; }

Property Value

string

DefaultAppName

public string DefaultAppName { get; }

Property Value

string

DiskLimit

Gets the maximum amount of disk available for the app instance

public virtual int DiskLimit { get; set; }

Property Value

int

EnvironmentName

public virtual string EnvironmentName { get; set; }

Property Value

string

EurekaInstanceNameKey

public string EurekaInstanceNameKey { get; }

Property Value

string

FileDescriptorLimit

Gets the maximum amount of file descriptors available to the app instance

public virtual int FileDescriptorLimit { get; set; }

Property Value

int

InstanceIP

Gets the external IP address of the host running the app instance

public virtual string InstanceIP { get; set; }

Property Value

string

InstanceId

public virtual string InstanceId { get; set; }

Property Value

string

InstanceIndex

Gets the index number of the app instance

public virtual int InstanceIndex { get; set; }

Property Value

int

Instance_Id

public string Instance_Id { get; set; }

Property Value

string

InternalIP

Gets the internal IP address of the container running the app instance instance

public virtual string InternalIP { get; set; }

Property Value

string

KubernetesNameKey

public string KubernetesNameKey { get; }

Property Value

string

ManagementNameKey

public string ManagementNameKey { get; }

Property Value

string

MemoryLimit

Gets the maximum amount of memory available for the app instance

public virtual int MemoryLimit { get; set; }

Property Value

int

Name

public virtual string Name { get; set; }

Property Value

string

PlatformNameKey

public string PlatformNameKey { get; }

Property Value

string

PlatformRoot

protected virtual string PlatformRoot { get; }

Property Value

string

Port

Gets the port assigned to the app instance, on which it should listen

public int Port { get; set; }

Property Value

int

Uris

Gets the URIs assigned to the app

public virtual IEnumerable<string> Uris { get; set; }

Property Value

IEnumerable<string>

Version

Gets a GUID identifying the application instance

public string Version { get; set; }

Property Value

string

Methods

ApplicationNameInContext(SteeltoeComponent, string)

Gets the name to use to represent the app instance in the context of a given Steeltoe component

public string ApplicationNameInContext(SteeltoeComponent steeltoeComponent, string additionalSearchPath = null)

Parameters

steeltoeComponent SteeltoeComponent

The Steeltoe component requesting the app's name

additionalSearchPath string

One additional config key to consider, used as top priority in search

Returns

string

The name of the application

SecondChanceSetIdProperties(IConfiguration)

protected void SecondChanceSetIdProperties(IConfiguration config = null)

Parameters

config IConfiguration