Package com.oracle.bmc.datasafe.requests

Class ListAlertAnalyticsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

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

      • compartmentIdInSubtree

        public ListAlertAnalyticsRequest.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 ListAlertAnalyticsRequest.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 ListAlertAnalyticsRequest.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 ListAlertAnalyticsRequest.Builder opcRequestId​(String opcRequestId)
        Unique identifier for the request.
        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • ifMatch

        public ListAlertAnalyticsRequest.Builder ifMatch​(String ifMatch)
        For optimistic concurrency control.

        In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

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

      • timeStarted

        public ListAlertAnalyticsRequest.Builder timeStarted​(Date timeStarted)
        An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.
        Parameters:
        timeStarted - the value to set
        Returns:
        this builder instance

      • timeEnded

        public ListAlertAnalyticsRequest.Builder timeEnded​(Date timeEnded)
        An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.
        Parameters:
        timeEnded - the value to set
        Returns:
        this builder instance

      • queryTimeZone

        public ListAlertAnalyticsRequest.Builder queryTimeZone​(String queryTimeZone)
        Default time zone is UTC if no time zone provided.

        The date-time considerations of the resource will be in accordance with the specified time zone.

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

      • accessLevel

        public ListAlertAnalyticsRequest.Builder accessLevel​(ListAlertAnalyticsRequest.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

      • scimQuery

        public ListAlertAnalyticsRequest.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') 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

      • groupBy

        public ListAlertAnalyticsRequest.Builder groupBy​(ListAlertAnalyticsRequest.GroupBy singularValue)
        Singular setter.

        A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

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

      • opcRetryToken

        public ListAlertAnalyticsRequest.Builder opcRetryToken​(String opcRetryToken)
        A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

        Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

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

      • invocationCallback

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