Application¶

class oci.functions.models.Application(**kwargs)¶

Bases: object

An application contains functions and defined attributes shared between those functions, such as network configuration and configuration. Avoid entering confidential information.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Application.
`SHAPE_GENERIC_ARM`	A constant which can be used with the shape property of a Application.
`SHAPE_GENERIC_X86`	A constant which can be used with the shape property of a Application.
`SHAPE_GENERIC_X86_ARM`	A constant which can be used with the shape property of a Application.
`compartment_id`	Gets the compartment_id of this Application.
`config`	Gets the config of this Application.
`defined_tags`	Gets the defined_tags of this Application.
`display_name`	Gets the display_name of this Application.
`freeform_tags`	Gets the freeform_tags of this Application.
`id`	[Required] Gets the id of this Application.
`image_policy_config`	Gets the image_policy_config of this Application.
`lifecycle_state`	Gets the lifecycle_state of this Application.
`network_security_group_ids`	Gets the network_security_group_ids of this Application.
`shape`	Gets the shape of this Application.
`subnet_ids`	Gets the subnet_ids of this Application.
`syslog_url`	Gets the syslog_url of this Application.
`time_created`	Gets the time_created of this Application.
`time_updated`	Gets the time_updated of this Application.
`trace_config`	Gets the trace_config of this Application.

Methods

__init__(**kwargs) Initializes a new Application object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “UPDATING”

SHAPE_GENERIC_ARM = 'GENERIC_ARM'¶: A constant which can be used with the shape property of a Application. This constant has a value of “GENERIC_ARM”

SHAPE_GENERIC_X86 = 'GENERIC_X86'¶: A constant which can be used with the shape property of a Application. This constant has a value of “GENERIC_X86”

SHAPE_GENERIC_X86_ARM = 'GENERIC_X86_ARM'¶: A constant which can be used with the shape property of a Application. This constant has a value of “GENERIC_X86_ARM”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this Application.
compartment_id (str) – The value to assign to the compartment_id property of this Application.
display_name (str) – The value to assign to the display_name property of this Application.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Application. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
config (dict(str, str)) – The value to assign to the config property of this Application.
subnet_ids (list[str]) – The value to assign to the subnet_ids property of this Application.
shape (str) – The value to assign to the shape property of this Application. Allowed values for this property are: “GENERIC_X86”, “GENERIC_ARM”, “GENERIC_X86_ARM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
network_security_group_ids (list[str]) – The value to assign to the network_security_group_ids property of this Application.
syslog_url (str) – The value to assign to the syslog_url property of this Application.
trace_config (oci.functions.models.ApplicationTraceConfig) – The value to assign to the trace_config property of this Application.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Application.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Application.
time_created (datetime) – The value to assign to the time_created property of this Application.
time_updated (datetime) – The value to assign to the time_updated property of this Application.
image_policy_config (oci.functions.models.ImagePolicyConfig) – The value to assign to the image_policy_config property of this Application.

compartment_id¶

Gets the compartment_id of this Application. The OCID of the compartment that contains the application.

Returns:	The compartment_id of this Application.
Return type:	str

config¶

Gets the config of this Application. Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration. Keys must be ASCII strings consisting solely of letters, digits, and the ‘_’ (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.

Example: {“MY_FUNCTION_CONFIG”: “ConfVal”}

The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.

Returns:	The config of this Application.
Return type:	dict(str, str)

defined_tags¶

Gets the defined_tags of this Application. 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 Application.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this Application. The display name of the application. The display name is unique within the compartment containing the application.

Returns:	The display_name of this Application.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Application. 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 Application.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Application. The `OCID`__ of the application.

Returns:	The id of this Application.
Return type:	str

image_policy_config¶

Gets the image_policy_config of this Application.

Returns:	The image_policy_config of this Application.
Return type:	oci.functions.models.ImagePolicyConfig

lifecycle_state¶

Gets the lifecycle_state of this Application. The current state of the application.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Application.
Return type:	str

network_security_group_ids¶

Gets the network_security_group_ids of this Application. The `OCID`__s of the Network Security Groups to add the application to.

Returns:	The network_security_group_ids of this Application.
Return type:	list[str]

shape¶

Gets the shape of this Application. Valid values are GENERIC_X86, GENERIC_ARM and GENERIC_X86_ARM. Default is GENERIC_X86. Setting this to GENERIC_X86, will run the functions in the application on X86 processor architecture. Setting this to GENERIC_ARM, will run the functions in the application on ARM processor architecture. When set to GENERIC_X86_ARM, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: GENERIC_X86, GENERIC_ARM, GENERIC_X86_ARM

Allowed values for this property are: “GENERIC_X86”, “GENERIC_ARM”, “GENERIC_X86_ARM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The shape of this Application.
Return type:	str

subnet_ids¶

Gets the subnet_ids of this Application. The `OCID`__s of the subnets in which to run functions in the application.

Returns:	The subnet_ids of this Application.
Return type:	list[str]

syslog_url¶

Gets the syslog_url of this Application. A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.

Example: tcp://logserver.myserver:1234

Returns:	The syslog_url of this Application.
Return type:	str

time_created¶

Gets the time_created of this Application. The time the application was created, expressed in `RFC 3339`__ timestamp format.

Example: 2018-09-12T22:47:12.613Z

Returns:	The time_created of this Application.
Return type:	datetime

time_updated¶

Gets the time_updated of this Application. The time the application was updated, expressed in `RFC 3339`__ timestamp format. Example: 2018-09-12T22:47:12.613Z

Returns:	The time_updated of this Application.
Return type:	datetime

trace_config¶

Gets the trace_config of this Application.

Returns:	The trace_config of this Application.
Return type:	oci.functions.models.ApplicationTraceConfig