CreateHostedApplicationDetails

class oci.generative_ai.models.CreateHostedApplicationDetails(**kwargs)

Bases: object

The details required to create a hosted application.

Methods:

__init__(**kwargs)

Initializes a new CreateHostedApplicationDetails object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this CreateHostedApplicationDetails.

defined_tags

Gets the defined_tags of this CreateHostedApplicationDetails.

description

Gets the description of this CreateHostedApplicationDetails.

display_name

[Required] Gets the display_name of this CreateHostedApplicationDetails.

environment_variables

Gets the environment_variables of this CreateHostedApplicationDetails.

freeform_tags

Gets the freeform_tags of this CreateHostedApplicationDetails.

inbound_auth_config

[Required] Gets the inbound_auth_config of this CreateHostedApplicationDetails.

networking_config

Gets the networking_config of this CreateHostedApplicationDetails.

public_access_path_patterns

Gets the public_access_path_patterns of this CreateHostedApplicationDetails.

scaling_config

Gets the scaling_config of this CreateHostedApplicationDetails.

storage_configs

Gets the storage_configs of this CreateHostedApplicationDetails.

__init__(**kwargs)

Initializes a new CreateHostedApplicationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • inbound_auth_config (oci.generative_ai.models.InboundAuthConfig) – The value to assign to the inbound_auth_config property of this CreateHostedApplicationDetails.

  • public_access_path_patterns (list[str]) – The value to assign to the public_access_path_patterns property of this CreateHostedApplicationDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateHostedApplicationDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateHostedApplicationDetails.

  • description (str) – The value to assign to the description property of this CreateHostedApplicationDetails.

  • scaling_config (oci.generative_ai.models.ScalingConfig) – The value to assign to the scaling_config property of this CreateHostedApplicationDetails.

  • networking_config (oci.generative_ai.models.NetworkingConfig) – The value to assign to the networking_config property of this CreateHostedApplicationDetails.

  • storage_configs (list[oci.generative_ai.models.StorageConfig]) – The value to assign to the storage_configs property of this CreateHostedApplicationDetails.

  • environment_variables (list[oci.generative_ai.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this CreateHostedApplicationDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateHostedApplicationDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateHostedApplicationDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateHostedApplicationDetails. The compartment OCID for the Hosted Application.

Returns

The compartment_id of this CreateHostedApplicationDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateHostedApplicationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateHostedApplicationDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateHostedApplicationDetails. The description for the Hosted Application.

Returns

The description of this CreateHostedApplicationDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateHostedApplicationDetails. The user-friendly display name for the Hosted Application. Does not need to be unique and can be updated after creation.

Returns

The display_name of this CreateHostedApplicationDetails.

Return type

str

property environment_variables

Gets the environment_variables of this CreateHostedApplicationDetails. The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

Returns

The environment_variables of this CreateHostedApplicationDetails.

Return type

list[oci.generative_ai.models.EnvironmentVariable]

property freeform_tags

Gets the freeform_tags of this CreateHostedApplicationDetails. 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”}

Returns

The freeform_tags of this CreateHostedApplicationDetails.

Return type

dict(str, str)

property inbound_auth_config

[Required] Gets the inbound_auth_config of this CreateHostedApplicationDetails.

Returns

The inbound_auth_config of this CreateHostedApplicationDetails.

Return type

oci.generative_ai.models.InboundAuthConfig

property networking_config

Gets the networking_config of this CreateHostedApplicationDetails.

Returns

The networking_config of this CreateHostedApplicationDetails.

Return type

oci.generative_ai.models.NetworkingConfig

property public_access_path_patterns

Gets the public_access_path_patterns of this CreateHostedApplicationDetails. A list of hosted application path patterns that can be accessed without inbound authentication. Values can be exact paths such as /health or /callback, or wildcard paths such as /assets/* or /public/*.

Returns

The public_access_path_patterns of this CreateHostedApplicationDetails.

Return type

list[str]

property scaling_config

Gets the scaling_config of this CreateHostedApplicationDetails.

Returns

The scaling_config of this CreateHostedApplicationDetails.

Return type

oci.generative_ai.models.ScalingConfig

property storage_configs

Gets the storage_configs of this CreateHostedApplicationDetails. A list of managed storage configurations for the application.

Returns

The storage_configs of this CreateHostedApplicationDetails.

Return type

list[oci.generative_ai.models.StorageConfig]