Class HostedApplication

Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resources.

Inheritance

object

HostedApplication

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiService.Models

Assembly: OCI.DotNetSDK.Generativeai.dll

Syntax

public class HostedApplication

Properties

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The compartment OCID to create the hosted application in.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	An optional description of the hosted application.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable.

Remarks

Required

EnvironmentVariables

Declaration

[JsonProperty(PropertyName = "environmentVariables")]
public List<EnvironmentVariable> EnvironmentVariables { get; set; }

Property Value

Type	Description
List<EnvironmentVariable>	The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the hosted application.

Remarks

Required

InboundAuthConfig

Declaration

[JsonProperty(PropertyName = "inboundAuthConfig")]
public InboundAuthConfig InboundAuthConfig { get; set; }

Property Value

Type	Description
InboundAuthConfig

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state of the endpoint in more detail that can provide actionable information.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HostedApplication.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
HostedApplication.LifecycleStateEnum?	The current state of the hosted application.

Remarks

Required

NetworkingConfig

Declaration

[JsonProperty(PropertyName = "networkingConfig")]
public NetworkingConfig NetworkingConfig { get; set; }

Property Value

Type	Description
NetworkingConfig

ScalingConfig

Declaration

[JsonProperty(PropertyName = "scalingConfig")]
public ScalingConfig ScalingConfig { get; set; }

Property Value

Type	Description
ScalingConfig

StorageConfigs

Declaration

[JsonProperty(PropertyName = "storageConfigs")]
public List<StorageConfig> StorageConfigs { get; set; }

Property Value

Type	Description
List<StorageConfig>	A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the hosted application was created, in the format defined by RFC 3339

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the hosted application was updated, in the format defined by RFC 3339