Class ListAlarmSuppressionsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • opcRequestId

        public ListAlarmSuppressionsRequest.Builder opcRequestId​(String opcRequestId)
        Customer part of the request identifier token.

        If you need to contact Oracle about a particular request, please provide the complete request ID.

        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance
      • displayName

        public ListAlarmSuppressionsRequest.Builder displayName​(String displayName)
        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.

        Parameters:
        displayName - the value to set
        Returns:
        this builder instance
      • lifecycleState

        public ListAlarmSuppressionsRequest.Builder lifecycleState​(AlarmSuppression.LifecycleState lifecycleState)
        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.

        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder instance
      • level

        public ListAlarmSuppressionsRequest.Builder level​(AlarmSuppression.Level level)
        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.

        Parameters:
        level - the value to set
        Returns:
        this builder instance
      • compartmentId

        public ListAlarmSuppressionsRequest.Builder compartmentId​(String compartmentId)
        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

        Parameters:
        compartmentId - the value to set
        Returns:
        this builder instance
      • compartmentIdInSubtree

        public ListAlarmSuppressionsRequest.Builder compartmentIdInSubtree​(Boolean compartmentIdInSubtree)
        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.

        Parameters:
        compartmentIdInSubtree - the value to set
        Returns:
        this builder instance
      • targetType

        public ListAlarmSuppressionsRequest.Builder targetType​(ListAlarmSuppressionsRequest.TargetType targetType)
        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.

        Parameters:
        targetType - the value to set
        Returns:
        this builder instance
      • isAllSuppressions

        public ListAlarmSuppressionsRequest.Builder isAllSuppressions​(Boolean isAllSuppressions)
        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.

        Parameters:
        isAllSuppressions - the value to set
        Returns:
        this builder instance
      • page

        public ListAlarmSuppressionsRequest.Builder page​(String page)
        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.

        Parameters:
        page - the value to set
        Returns:
        this builder instance
      • limit

        public ListAlarmSuppressionsRequest.Builder limit​(Integer limit)
        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

        Parameters:
        limit - the value to set
        Returns:
        this builder instance
      • invocationCallback

        public ListAlarmSuppressionsRequest.Builder invocationCallback​(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
        Set the invocation callback for the request to be built.
        Parameters:
        invocationCallback - the invocation callback to be set for the request
        Returns:
        this builder instance
      • retryConfiguration

        public ListAlarmSuppressionsRequest.Builder retryConfiguration​(RetryConfiguration retryConfiguration)
        Set the retry configuration for the request to be built.
        Parameters:
        retryConfiguration - the retry configuration to be used for the request
        Returns:
        this builder instance