OnboardConfigDetails¶

class oci.stack_monitoring.models.OnboardConfigDetails(**kwargs)¶

Bases: oci.stack_monitoring.models.config.Config

A configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

Attributes

`CONFIG_TYPE_AUTO_PROMOTE`	str(object=’’) -> str
`CONFIG_TYPE_COMPUTE_AUTO_ACTIVATE_PLUGIN`	str(object=’’) -> str
`CONFIG_TYPE_LICENSE_AUTO_ASSIGN`	str(object=’’) -> str
`CONFIG_TYPE_LICENSE_ENTERPRISE_EXTENSIBILITY`	str(object=’’) -> str
`CONFIG_TYPE_ONBOARD`	str(object=’’) -> str
`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
`additional_configurations`	Gets the additional_configurations of this OnboardConfigDetails.
`compartment_id`	[Required] Gets the compartment_id of this Config.
`config_type`	[Required] Gets the config_type of this Config.
`defined_tags`	Gets the defined_tags of this Config.
`display_name`	Gets the display_name of this Config.
`dynamic_groups`	Gets the dynamic_groups of this OnboardConfigDetails.
`freeform_tags`	Gets the freeform_tags of this Config.
`id`	[Required] Gets the id of this Config.
`is_manually_onboarded`	[Required] Gets the is_manually_onboarded of this OnboardConfigDetails.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Config.
`policy_names`	Gets the policy_names of this OnboardConfigDetails.
`system_tags`	Gets the system_tags of this Config.
`time_created`	Gets the time_created of this Config.
`time_updated`	Gets the time_updated of this Config.
`user_groups`	Gets the user_groups of this OnboardConfigDetails.
`version`	Gets the version of this OnboardConfigDetails.

Methods

`__init__`(**kwargs)	Initializes a new OnboardConfigDetails 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.

CONFIG_TYPE_AUTO_PROMOTE = 'AUTO_PROMOTE'¶

CONFIG_TYPE_COMPUTE_AUTO_ACTIVATE_PLUGIN = 'COMPUTE_AUTO_ACTIVATE_PLUGIN'¶

CONFIG_TYPE_LICENSE_AUTO_ASSIGN = 'LICENSE_AUTO_ASSIGN'¶

CONFIG_TYPE_LICENSE_ENTERPRISE_EXTENSIBILITY = 'LICENSE_ENTERPRISE_EXTENSIBILITY'¶

CONFIG_TYPE_ONBOARD = 'ONBOARD'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

Initializes a new OnboardConfigDetails object with values from keyword arguments. The default value of the config_type attribute of this class is ONBOARD 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 OnboardConfigDetails.
compartment_id (str) – The value to assign to the compartment_id property of this OnboardConfigDetails.
display_name (str) – The value to assign to the display_name property of this OnboardConfigDetails.
time_created (datetime) – The value to assign to the time_created property of this OnboardConfigDetails.
time_updated (datetime) – The value to assign to the time_updated property of this OnboardConfigDetails.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OnboardConfigDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
config_type (str) – The value to assign to the config_type property of this OnboardConfigDetails. Allowed values for this property are: “AUTO_PROMOTE”, “COMPUTE_AUTO_ACTIVATE_PLUGIN”, “LICENSE_AUTO_ASSIGN”, “LICENSE_ENTERPRISE_EXTENSIBILITY”, “ONBOARD”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OnboardConfigDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OnboardConfigDetails.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OnboardConfigDetails.
version (str) – The value to assign to the version property of this OnboardConfigDetails.
is_manually_onboarded (bool) – The value to assign to the is_manually_onboarded property of this OnboardConfigDetails.
policy_names (list[str]) – The value to assign to the policy_names property of this OnboardConfigDetails.
dynamic_groups (list[oci.stack_monitoring.models.DynamicGroupDetails]) – The value to assign to the dynamic_groups property of this OnboardConfigDetails.
user_groups (list[oci.stack_monitoring.models.GroupDetails]) – The value to assign to the user_groups property of this OnboardConfigDetails.
additional_configurations (oci.stack_monitoring.models.AdditionalConfigurationDetails) – The value to assign to the additional_configurations property of this OnboardConfigDetails.

additional_configurations¶

Gets the additional_configurations of this OnboardConfigDetails.

Returns:	The additional_configurations of this OnboardConfigDetails.
Return type:	oci.stack_monitoring.models.AdditionalConfigurationDetails

compartment_id¶

[Required] Gets the compartment_id of this Config. The OCID of the compartment containing the configuration.

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

config_type¶

[Required] Gets the config_type of this Config. The type of configuration.

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

Returns:	The config_type of this Config.
Return type:	str

defined_tags¶

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

display_name¶

Gets the display_name of this Config. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

dynamic_groups¶

Gets the dynamic_groups of this OnboardConfigDetails. List of dynamic groups dedicated for Stack Monitoring.

Returns:	The dynamic_groups of this OnboardConfigDetails.
Return type:	list[oci.stack_monitoring.models.DynamicGroupDetails]

freeform_tags¶

Gets the freeform_tags of this Config. 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 Config.
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¶

[Required] Gets the id of this Config. The Unique Oracle ID (OCID) that is immutable on creation.

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

is_manually_onboarded¶

[Required] Gets the is_manually_onboarded of this OnboardConfigDetails. True if customer decides marks configuration as manually configured.

Returns:	The is_manually_onboarded of this OnboardConfigDetails.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this Config. The current state of the configuration.

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 Config.
Return type:	str

policy_names¶

Gets the policy_names of this OnboardConfigDetails. List of policy names assigned for onboarding

Returns:	The policy_names of this OnboardConfigDetails.
Return type:	list[str]

system_tags¶

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

time_created¶

Gets the time_created of this Config. The time the configuration was created. An RFC3339 formatted datetime string.

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

time_updated¶

Gets the time_updated of this Config. The time the Config was updated.

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

user_groups¶

Gets the user_groups of this OnboardConfigDetails. List of user groups dedicated for Stack Monitoring.

Returns:	The user_groups of this OnboardConfigDetails.
Return type:	list[oci.stack_monitoring.models.GroupDetails]

version¶

Gets the version of this OnboardConfigDetails. Assigned version to given onboard configuration.

Returns:	The version of this OnboardConfigDetails.
Return type:	str