UpdateOnboardConfigDetails

class oci.stack_monitoring.models.UpdateOnboardConfigDetails(**kwargs)

Bases: UpdateConfigDetails

Update configuration object, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

Methods:

__init__(**kwargs)

Initializes a new UpdateOnboardConfigDetails 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:

additional_configurations

Gets the additional_configurations of this UpdateOnboardConfigDetails.

config_type

Gets the config_type of this UpdateConfigDetails.

defined_tags

Gets the defined_tags of this UpdateConfigDetails.

display_name

Gets the display_name of this UpdateConfigDetails.

dynamic_groups

Gets the dynamic_groups of this UpdateOnboardConfigDetails.

freeform_tags

Gets the freeform_tags of this UpdateConfigDetails.

is_manually_onboarded

Gets the is_manually_onboarded of this UpdateOnboardConfigDetails.

policy_names

Gets the policy_names of this UpdateOnboardConfigDetails.

user_groups

Gets the user_groups of this UpdateOnboardConfigDetails.

version

Gets the version of this UpdateOnboardConfigDetails.

__init__(**kwargs)

Initializes a new UpdateOnboardConfigDetails 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
  • display_name (str) – The value to assign to the display_name property of this UpdateOnboardConfigDetails.

  • config_type (str) – The value to assign to the config_type property of this UpdateOnboardConfigDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateOnboardConfigDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateOnboardConfigDetails.

  • version (str) – The value to assign to the version property of this UpdateOnboardConfigDetails.

  • is_manually_onboarded (bool) – The value to assign to the is_manually_onboarded property of this UpdateOnboardConfigDetails.

  • policy_names (list[str]) – The value to assign to the policy_names property of this UpdateOnboardConfigDetails.

  • dynamic_groups (list[oci.stack_monitoring.models.DynamicGroupDetails]) – The value to assign to the dynamic_groups property of this UpdateOnboardConfigDetails.

  • user_groups (list[oci.stack_monitoring.models.GroupDetails]) – The value to assign to the user_groups property of this UpdateOnboardConfigDetails.

  • additional_configurations (oci.stack_monitoring.models.AdditionalConfigurationDetails) – The value to assign to the additional_configurations property of this UpdateOnboardConfigDetails.

property additional_configurations

Gets the additional_configurations of this UpdateOnboardConfigDetails.

Returns

The additional_configurations of this UpdateOnboardConfigDetails.

Return type

oci.stack_monitoring.models.AdditionalConfigurationDetails

property config_type

Gets the config_type of this UpdateConfigDetails. The type of configuration.

Returns

The config_type of this UpdateConfigDetails.

Return type

str

property defined_tags

Gets the defined_tags of this UpdateConfigDetails. 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 UpdateConfigDetails.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this UpdateConfigDetails. The display name of the configuration.

Returns

The display_name of this UpdateConfigDetails.

Return type

str

property dynamic_groups

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

Returns

The dynamic_groups of this UpdateOnboardConfigDetails.

Return type

list[oci.stack_monitoring.models.DynamicGroupDetails]

property freeform_tags

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

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 is_manually_onboarded

Gets the is_manually_onboarded of this UpdateOnboardConfigDetails. True if customer decides marks configuration as manually configured.

Returns

The is_manually_onboarded of this UpdateOnboardConfigDetails.

Return type

bool

property policy_names

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

Returns

The policy_names of this UpdateOnboardConfigDetails.

Return type

list[str]

property user_groups

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

Returns

The user_groups of this UpdateOnboardConfigDetails.

Return type

list[oci.stack_monitoring.models.GroupDetails]

property version

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

Returns

The version of this UpdateOnboardConfigDetails.

Return type

str