ConfigurationSummary¶

class oci.mysql.models.ConfigurationSummary(**kwargs)¶

Bases: object

The general details of a Configuration such as its id, displayName, type, and shape association.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this ConfigurationSummary.
`defined_tags`	Gets the defined_tags of this ConfigurationSummary.
`description`	Gets the description of this ConfigurationSummary.
`display_name`	Gets the display_name of this ConfigurationSummary.
`freeform_tags`	Gets the freeform_tags of this ConfigurationSummary.
`id`	[Required] Gets the id of this ConfigurationSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConfigurationSummary.
`shape_name`	[Required] Gets the shape_name of this ConfigurationSummary.
`system_tags`	Gets the system_tags of this ConfigurationSummary.
`time_created`	Gets the time_created of this ConfigurationSummary.
`time_updated`	Gets the time_updated of this ConfigurationSummary.
`type`	[Required] Gets the type of this ConfigurationSummary.

__init__(**kwargs)¶

Initializes a new ConfigurationSummary 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 ConfigurationSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ConfigurationSummary.
description (str) – The value to assign to the description property of this ConfigurationSummary.
display_name (str) – The value to assign to the display_name property of this ConfigurationSummary.
shape_name (str) – The value to assign to the shape_name property of this ConfigurationSummary.
type (str) – The value to assign to the type property of this ConfigurationSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConfigurationSummary.
time_created (datetime) – The value to assign to the time_created property of this ConfigurationSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ConfigurationSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ConfigurationSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ConfigurationSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ConfigurationSummary.

compartment_id¶

[Required] Gets the compartment_id of this ConfigurationSummary. OCID of the Compartment the Configuration exists in.

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

defined_tags¶

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

description¶

Gets the description of this ConfigurationSummary. User-provided data about the Configuration.

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

display_name¶

Gets the display_name of this ConfigurationSummary. The display name of the Configuration.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ConfigurationSummary. The OCID of the Configuration.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConfigurationSummary. The current state of the Configuration.

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

shape_name¶

[Required] Gets the shape_name of this ConfigurationSummary. The name of the associated Shape.

Returns:	The shape_name of this ConfigurationSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ConfigurationSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

Gets the time_created of this ConfigurationSummary. The date and time the Configuration was created, as described by RFC 3339.

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

time_updated¶

Gets the time_updated of this ConfigurationSummary. The date and time the Configuration was last updated, as described by RFC 3339.

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

type¶

[Required] Gets the type of this ConfigurationSummary. The Configuration type, DEFAULT or CUSTOM

Returns:	The type of this ConfigurationSummary.
Return type:	str