OnboardConfigSummary¶
- class oci.stack_monitoring.models.OnboardConfigSummary(**kwargs)¶
Bases:
ConfigSummaryA configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.
Methods:
__init__(**kwargs)Initializes a new OnboardConfigSummary 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.
Attributes:
[Required] Gets the compartment_id of this ConfigSummary.
[Required] Gets the config_type of this ConfigSummary.
Gets the defined_tags of this ConfigSummary.
Gets the display_name of this ConfigSummary.
Gets the freeform_tags of this ConfigSummary.
[Required] Gets the id of this ConfigSummary.
[Required] Gets the is_manually_onboarded of this OnboardConfigSummary.
[Required] Gets the lifecycle_state of this ConfigSummary.
Gets the system_tags of this ConfigSummary.
Gets the time_created of this ConfigSummary.
Gets the time_updated of this ConfigSummary.
Gets the version of this OnboardConfigSummary.
- __init__(**kwargs)¶
Initializes a new OnboardConfigSummary object with values from keyword arguments. The default value of the
config_typeattribute of this class isONBOARDand 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 OnboardConfigSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OnboardConfigSummary.
display_name (str) – The value to assign to the display_name property of this OnboardConfigSummary.
time_created (datetime) – The value to assign to the time_created property of this OnboardConfigSummary.
time_updated (datetime) – The value to assign to the time_updated property of this OnboardConfigSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OnboardConfigSummary.
config_type (str) – The value to assign to the config_type property of this OnboardConfigSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OnboardConfigSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OnboardConfigSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OnboardConfigSummary.
version (str) – The value to assign to the version property of this OnboardConfigSummary.
is_manually_onboarded (bool) – The value to assign to the is_manually_onboarded property of this OnboardConfigSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this ConfigSummary. Compartment Identifier.
- Returns
The compartment_id of this ConfigSummary.
- Return type
str
- property config_type¶
[Required] Gets the config_type of this ConfigSummary. The type of configuration.
- Returns
The config_type of this ConfigSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ConfigSummary. 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 ConfigSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this ConfigSummary. Config Identifier, can be renamed.
- Returns
The display_name of this ConfigSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ConfigSummary. 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 ConfigSummary.
- 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.
- property id¶
[Required] Gets the id of this ConfigSummary. Unique identifier that is immutable on creation.
- Returns
The id of this ConfigSummary.
- Return type
str
- property is_manually_onboarded¶
[Required] Gets the is_manually_onboarded of this OnboardConfigSummary. True if customer decides marks configuration as manually configured.
- Returns
The is_manually_onboarded of this OnboardConfigSummary.
- Return type
bool
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ConfigSummary. The current state of the configuration.
- Returns
The lifecycle_state of this ConfigSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ConfigSummary. 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 ConfigSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this ConfigSummary. The time the the configuration was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this ConfigSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this ConfigSummary. The time the configuration was updated.
- Returns
The time_updated of this ConfigSummary.
- Return type
datetime
- property version¶
Gets the version of this OnboardConfigSummary. Assigned version to given onboard configuration.
- Returns
The version of this OnboardConfigSummary.
- Return type
str