Package com.oracle.bmc.datasafe.requests

Class ListAlertAnalyticsRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class ListAlertAnalyticsRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/datasafe/ListAlertAnalyticsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAlertAnalyticsRequest.

    • Constructor Detail

      • ListAlertAnalyticsRequest

        public ListAlertAnalyticsRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        A filter to return only resources that match the specified compartment OCID.

      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        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.

      • getLimit

        public Integer getLimit()
        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.

      • getPage

        public String getPage()
        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.

      • getOpcRequestId

        public String getOpcRequestId()
        Unique identifier for the request.

      • getIfMatch

        public String getIfMatch()
        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.

      • getTimeStarted

        public Date getTimeStarted()
        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.

      • getTimeEnded

        public Date getTimeEnded()
        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.

      • getQueryTimeZone

        public String getQueryTimeZone()
        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.

      • getSortBy

        public ListAlertAnalyticsRequest.SortBy getSortBy()
        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.

      • getAccessLevel

        public ListAlertAnalyticsRequest.AccessLevel getAccessLevel()
        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.

      • getScimQuery

        public String getScimQuery()
        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)

      • getGroupBy

        public List<ListAlertAnalyticsRequest.GroupBy> getGroupBy()
        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.

      • getOpcRetryToken

        public String getOpcRetryToken()
        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.

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>