AlarmSuppressionCompartmentTarget¶

class oci.monitoring.models.AlarmSuppressionCompartmentTarget(**kwargs)¶

Bases: oci.monitoring.models.alarm_suppression_target.AlarmSuppressionTarget

The compartment target of the alarm suppression.

Attributes

`TARGET_TYPE_ALARM`	str(object=’’) -> str
`TARGET_TYPE_COMPARTMENT`	str(object=’’) -> str
`compartment_id`	[Required] Gets the compartment_id of this AlarmSuppressionCompartmentTarget.
`compartment_id_in_subtree`	Gets the compartment_id_in_subtree of this AlarmSuppressionCompartmentTarget.
`target_type`	[Required] Gets the target_type of this AlarmSuppressionTarget.

Methods

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

TARGET_TYPE_ALARM = 'ALARM'¶

TARGET_TYPE_COMPARTMENT = 'COMPARTMENT'¶

__init__(**kwargs)¶

Initializes a new AlarmSuppressionCompartmentTarget object with values from keyword arguments. The default value of the target_type attribute of this class is COMPARTMENT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

target_type (str) – The value to assign to the target_type property of this AlarmSuppressionCompartmentTarget. Allowed values for this property are: “ALARM”, “COMPARTMENT”
compartment_id (str) – The value to assign to the compartment_id property of this AlarmSuppressionCompartmentTarget.
compartment_id_in_subtree (bool) – The value to assign to the compartment_id_in_subtree property of this AlarmSuppressionCompartmentTarget.

compartment_id¶

[Required] Gets the compartment_id of this AlarmSuppressionCompartmentTarget. The OCID of the compartment or tenancy that is the target of the alarm suppression. Example: ocid1.compartment.oc1..exampleuniqueID

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

compartment_id_in_subtree¶

Gets the compartment_id_in_subtree of this AlarmSuppressionCompartmentTarget. When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment.

Returns:	The compartment_id_in_subtree of this AlarmSuppressionCompartmentTarget.
Return type:	bool

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.

target_type¶

[Required] Gets the target_type of this AlarmSuppressionTarget. The type of the alarm suppression target.

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

Returns:	The target_type of this AlarmSuppressionTarget.
Return type:	str