OpsiUxConfiguration¶

class oci.opsi.models.OpsiUxConfiguration(**kwargs)¶

Bases: oci.opsi.models.opsi_configuration.OpsiConfiguration

OPSI UX configuration.

Attributes

`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`OPSI_CONFIG_TYPE_UX_CONFIGURATION`	str(object=’’) -> str
`compartment_id`	Gets the compartment_id of this OpsiConfiguration.
`config_items`	Gets the config_items of this OpsiConfiguration.
`defined_tags`	Gets the defined_tags of this OpsiConfiguration.
`description`	Gets the description of this OpsiConfiguration.
`display_name`	Gets the display_name of this OpsiConfiguration.
`freeform_tags`	Gets the freeform_tags of this OpsiConfiguration.
`id`	Gets the id of this OpsiConfiguration.
`lifecycle_details`	Gets the lifecycle_details of this OpsiConfiguration.
`lifecycle_state`	Gets the lifecycle_state of this OpsiConfiguration.
`opsi_config_type`	[Required] Gets the opsi_config_type of this OpsiConfiguration.
`system_tags`	Gets the system_tags of this OpsiConfiguration.
`time_created`	Gets the time_created of this OpsiConfiguration.
`time_updated`	Gets the time_updated of this OpsiConfiguration.

Methods

`__init__`(**kwargs)	Initializes a new OpsiUxConfiguration object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

OPSI_CONFIG_TYPE_UX_CONFIGURATION = 'UX_CONFIGURATION'¶

__init__(**kwargs)¶

Initializes a new OpsiUxConfiguration object with values from keyword arguments. The default value of the opsi_config_type attribute of this class is UX_CONFIGURATION and it should not be changed. 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 OpsiUxConfiguration.
compartment_id (str) – The value to assign to the compartment_id property of this OpsiUxConfiguration.
opsi_config_type (str) – The value to assign to the opsi_config_type property of this OpsiUxConfiguration. Allowed values for this property are: “UX_CONFIGURATION”
display_name (str) – The value to assign to the display_name property of this OpsiUxConfiguration.
description (str) – The value to assign to the description property of this OpsiUxConfiguration.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpsiUxConfiguration.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpsiUxConfiguration.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpsiUxConfiguration.
time_created (datetime) – The value to assign to the time_created property of this OpsiUxConfiguration.
time_updated (datetime) – The value to assign to the time_updated property of this OpsiUxConfiguration.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpsiUxConfiguration. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OpsiUxConfiguration.
config_items (list[oci.opsi.models.OpsiConfigurationConfigurationItemSummary]) – The value to assign to the config_items property of this OpsiUxConfiguration.

compartment_id¶

Gets the compartment_id of this OpsiConfiguration. The OCID of the compartment.

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

config_items¶

Gets the config_items of this OpsiConfiguration. Array of configuration item summary objects.

Returns:	The config_items of this OpsiConfiguration.
Return type:	list[oci.opsi.models.OpsiConfigurationConfigurationItemSummary]

defined_tags¶

Gets the defined_tags of this OpsiConfiguration. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this OpsiConfiguration.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this OpsiConfiguration. Description of OPSI configuration.

Returns:	The description of this OpsiConfiguration.
Return type:	str

display_name¶

Gets the display_name of this OpsiConfiguration. User-friendly display name for the OPSI configuration. The name does not have to be unique.

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

freeform_tags¶

Gets the freeform_tags of this OpsiConfiguration. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this OpsiConfiguration.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

Gets the id of this OpsiConfiguration. OCID of OPSI configuration resource.

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

lifecycle_details¶

Gets the lifecycle_details of this OpsiConfiguration. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecycle_details of this OpsiConfiguration.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this OpsiConfiguration. OPSI configuration resource lifecycle state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 OpsiConfiguration.
Return type:	str

opsi_config_type¶

[Required] Gets the opsi_config_type of this OpsiConfiguration. OPSI configuration type.

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

Returns:	The opsi_config_type of this OpsiConfiguration.
Return type:	str

system_tags¶

Gets the system_tags of this OpsiConfiguration. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this OpsiConfiguration.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this OpsiConfiguration. The time at which the resource was first created. An RFC3339 formatted datetime string

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

time_updated¶

Gets the time_updated of this OpsiConfiguration. The time at which the resource was last updated. An RFC3339 formatted datetime string

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