Class ListAlarmSuppressionsRequest

Inheritance

object

ListAlarmSuppressionsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Requests

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class ListAlarmSuppressionsRequest : IOciRequest

Examples

Click here to see an example of how to use ListAlarmSuppressions request.

Properties

AlarmId

Declaration

[HttpConverter(TargetEnum.Query, "alarmId")]
public string AlarmId { get; set; }

Property Value

Type	Description
string	The OCID of the alarm that is the target of the alarm suppression.

CompartmentId

Declaration

[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment for searching. Use the tenancy OCID to search in the root compartment. If targetType is not specified, searches all suppressions defined under the compartment. If targetType is COMPARTMENT, searches suppressions in the specified compartment only. Example: ocid1.compartment.oc1..exampleuniqueID

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type

Description

bool?

When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given display name exactly. Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.

IsAllSuppressions

Declaration

[HttpConverter(TargetEnum.Query, "isAllSuppressions")]
public bool? IsAllSuppressions { get; set; }

Property Value

Type	Description
bool?	Setting this parameter to true requires the query to specify the alarm (alarmId). When true, lists all alarm suppressions that affect the specified alarm, including suppressions that target the corresponding compartment or tenancy. When false, lists only the alarm suppressions that target the specified alarm. Default is false.

Level

Declaration

[HttpConverter(TargetEnum.Query, "level")]
public AlarmSuppression.LevelEnum? Level { get; set; }

Property Value

Type	Description
AlarmSuppression.LevelEnum?	The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public AlarmSuppression.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
AlarmSuppression.LifecycleStateEnum?	A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAlarmSuppressionsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListAlarmSuppressionsRequest.SortByEnum?	The field to use when sorting returned alarm suppressions. Only one sorting level is provided. Example: timeCreated

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAlarmSuppressionsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListAlarmSuppressionsRequest.SortOrderEnum?	The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC). Example: ASC

TargetType

Declaration

[HttpConverter(TargetEnum.Query, "targetType")]
public ListAlarmSuppressionsRequest.TargetTypeEnum? TargetType { get; set; }

Property Value

Type	Description
ListAlarmSuppressionsRequest.TargetTypeEnum?	The target type to use when listing alarm suppressions. ALARM lists all suppression records for the specified alarm. COMPARTMENT lists all suppression records for the specified compartment or tenancy.

Implements

IOciRequest