Package com.oracle.bmc.datasafe.requests

Class ListAlertsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public ListAlertsRequest.Builder compartmentId​(String compartmentId)
        A filter to return only resources that match the specified compartment OCID.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder instance

      • id

        public ListAlertsRequest.Builder id​(String id)
        A filter to return alert by it’s OCID.
        Parameters:
        id - the value to set
        Returns:
        this builder instance

      • compartmentIdInSubtree

        public ListAlertsRequest.Builder compartmentIdInSubtree​(Boolean compartmentIdInSubtree)
        Default is false.

        When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

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

      • limit

        public ListAlertsRequest.Builder limit​(Integer limit)
        For list pagination.

        The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

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

      • page

        public ListAlertsRequest.Builder page​(String page)
        For list pagination.

        The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

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

      • opcRequestId

        public ListAlertsRequest.Builder opcRequestId​(String opcRequestId)
        Unique identifier for the request.
        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • accessLevel

        public ListAlertsRequest.Builder accessLevel​(ListAlertsRequest.AccessLevel accessLevel)
        Valid values are RESTRICTED and ACCESSIBLE.

        Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

        Parameters:
        accessLevel - the value to set
        Returns:
        this builder instance

      • sortBy

        public ListAlertsRequest.Builder sortBy​(ListAlertsRequest.SortBy sortBy)
        The field to sort by.

        Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.

        Parameters:
        sortBy - the value to set
        Returns:
        this builder instance

      • scimQuery

        public ListAlertsRequest.Builder scimQuery​(String scimQuery)
        The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339.

        In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

        *Example:** | query=(timeCreated ge "2021-06-04T01:00:26.000Z") and (targetNames eq "target_1") query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

        Parameters:
        scimQuery - the value to set
        Returns:
        this builder instance

      • field

        public ListAlertsRequest.Builder field​(ListAlertsRequest.Field singularValue)
        Singular setter.

        Specifies a subset of fields to be returned in the response.

        Parameters:
        singularValue - the singular value to set
        Returns:
        this builder instance

      • invocationCallback

        public ListAlertsRequest.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 ListAlertsRequest.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