Class CloudFoundryApplicationOptions

Namespace

Steeltoe.Configuration.CloudFoundry

Assembly

Steeltoe.Configuration.CloudFoundry.dll

public sealed class CloudFoundryApplicationOptions : ApplicationInstanceInfo, IApplicationInstanceInfo

Inheritance

object

ApplicationInstanceInfo

CloudFoundryApplicationOptions

Implements

IApplicationInstanceInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Api

Gets or sets the location of the Cloud Controller API for the Cloud Foundry deployment where the app runs.

[ConfigurationKeyName("cf_api")]
public string? Api { get; set; }

Property Value

string

ApplicationId

Gets or sets the GUID identifying the app.

[ConfigurationKeyName("application_id")]
public string? ApplicationId { get; set; }

Property Value

string

ApplicationName

Gets or sets the name assigned to the app when it was pushed.

[ConfigurationKeyName("application_name")]
public override string? ApplicationName { get; set; }

Property Value

string

ApplicationVersion

Gets or sets the GUID identifying a version of the app. Each time an app is pushed or restarted, this value is updated.

[ConfigurationKeyName("application_version")]
public string? ApplicationVersion { get; set; }

Property Value

string

InstanceIP

Gets or sets the external IP address of the host running the app instance. Originates from the CF_INSTANCE_IP environment variable.

[ConfigurationKeyName("instance_ip")]
public string? InstanceIP { get; set; }

Property Value

string

InstanceId

Gets or sets the UUID of the app instance. Originates from the CF_INSTANCE_GUID environment variable.

[ConfigurationKeyName("instance_id")]
public string? InstanceId { get; set; }

Property Value

string

InstanceIndex

Gets or sets the zero-based index number of the app instance. Originates from the CF_INSTANCE_INDEX environment variable.

[ConfigurationKeyName("instance_index")]
public int InstanceIndex { get; set; }

Property Value

int

InstancePort

Gets or sets the external (host-side) port corresponding to the internal (container-side) port. Originates from the CF_INSTANCE_PORT environment variable.

[ConfigurationKeyName("port")]
public int InstancePort { get; set; }

Property Value

int

InternalIP

Gets or sets the internal IP address of the container running the app instance. Originates from the CF_INSTANCE_INTERNAL_IP environment variable.

[ConfigurationKeyName("internal_ip")]
public string? InternalIP { get; set; }

Property Value

string

Limits

Gets or sets the limits to disk space, number of files, and memory permitted to the app. Memory and disk space limits are supplied when the app is deployed, either on the command line or in the app manifest. The number of files allowed is operator-defined.

public ApplicationLimits? Limits { get; set; }

Property Value

ApplicationLimits

OrganizationId

Gets or sets the GUID identifying the org where the app is deployed.

[ConfigurationKeyName("organization_id")]
public string? OrganizationId { get; set; }

Property Value

string

OrganizationName

Gets or sets the human-readable name of the org where the app is deployed.

[ConfigurationKeyName("organization_name")]
public string? OrganizationName { get; set; }

Property Value

string

ProcessId

Gets or sets the UID identifying the process. Only present in running application containers.

[ConfigurationKeyName("process_id")]
public string? ProcessId { get; set; }

Property Value

string

ProcessType

Gets or sets the type of process. Only present in running application containers.

[ConfigurationKeyName("process_type")]
public string? ProcessType { get; set; }

Property Value

string

SpaceId

Gets or sets the GUID identifying the space where the app is deployed.

[ConfigurationKeyName("space_id")]
public string? SpaceId { get; set; }

Property Value

string

SpaceName

Gets or sets the human-readable name of the space where the app is deployed.

[ConfigurationKeyName("space_name")]
public string? SpaceName { get; set; }

Property Value

string

Start

Gets or sets the human-readable timestamp for the time the instance was started. Not provided on Diego Cells.

[ConfigurationKeyName("start")]
public string? Start { get; set; }

Property Value

string

StartedAtTimestamp

Gets or sets the UNIX epoch timestamp for the time the instance was started. Not provided on Diego Cells.

[ConfigurationKeyName("started_at_timestamp")]
public long StartedAtTimestamp { get; set; }

Property Value

long

Uris

Gets the URIs assigned to the app.

[ConfigurationKeyName("application_uris")]
public IList<string> Uris { get; }

Property Value

IList<string>