Class ListAuditEventAnalyticsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListAuditEventAnalyticsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListAuditEventAnalyticsRequest extends BmcRequest<Void>
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListAuditEventAnalyticsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAuditEventAnalyticsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListAuditEventAnalyticsRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListAuditEventAnalyticsRequest.Builder
static class
ListAuditEventAnalyticsRequest.GroupBy
A groupBy can only be used in combination with summaryField parameter.static class
ListAuditEventAnalyticsRequest.SortBy
If this query parameter is specified, the result is ordered based on this query parameter value.static class
ListAuditEventAnalyticsRequest.SortOrder
The sort order to use, either ascending (ASC) or descending (DESC).static class
ListAuditEventAnalyticsRequest.SummaryField
Specifies a subset of summarized fields to be returned in the response.
-
Constructor Summary
Constructors Constructor Description ListAuditEventAnalyticsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListAuditEventAnalyticsRequest.Builder
builder()
Return a new builder for this request object.boolean
equals(Object o)
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListAuditEventAnalyticsRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.String
getCompartmentId()
A filter to return only resources that match the specified compartment OCID.Boolean
getCompartmentIdInSubtree()
Default is false.List<ListAuditEventAnalyticsRequest.GroupBy>
getGroupBy()
A groupBy can only be used in combination with summaryField parameter.String
getIfMatch()
For optimistic concurrency control.Integer
getLimit()
For details about how pagination works, see List Pagination.String
getOpcRequestId()
Unique identifier for the request.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.String
getPage()
It is usually retrieved from a previous “List” call.String
getQueryTimeZone()
Default time zone is UTC if no time zone provided.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.ListAuditEventAnalyticsRequest.SortBy
getSortBy()
If this query parameter is specified, the result is ordered based on this query parameter value.ListAuditEventAnalyticsRequest.SortOrder
getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).List<ListAuditEventAnalyticsRequest.SummaryField>
getSummaryField()
Specifies a subset of summarized fields to be returned in the response.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.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.int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListAuditEventAnalyticsRequest.Builder
toBuilder()
Return an instance ofListAuditEventAnalyticsRequest.Builder
that allows you to modify request properties.String
toString()
-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
A filter to return only resources that match the specified compartment OCID.
-
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.
-
getLimit
public Integer getLimit()
For details about how pagination works, see List Pagination.
-
getPage
public String getPage()
It is usually retrieved from a previous “List” call.For details about how pagination works, see List Pagination.
-
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.
-
getAccessLevel
public ListAuditEventAnalyticsRequest.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:** (operationTime ge "2021-06-04T01-00-26") and (eventName eq "LOGON") The attrExp or the field (for example, operationTime and eventName in above example) which is used to filter can be any of the fields returned by AuditEventSummary. adminUser, commonUser, sensitiveActivity, dsActivity can only have eq operation and value 1. These define admin user activity, common user activity, sensitive data activity and data safe activity **Example:** (adminUser eq 1)
-
getSummaryField
public List<ListAuditEventAnalyticsRequest.SummaryField> getSummaryField()
Specifies a subset of summarized fields to be returned in the response.
-
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.
-
getGroupBy
public List<ListAuditEventAnalyticsRequest.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.
-
getSortOrder
public ListAuditEventAnalyticsRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListAuditEventAnalyticsRequest.SortBy getSortBy()
If this query parameter is specified, the result is ordered based on this query parameter value.
-
toBuilder
public ListAuditEventAnalyticsRequest.Builder toBuilder()
Return an instance ofListAuditEventAnalyticsRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListAuditEventAnalyticsRequest.Builder
that allows you to modify request properties.
-
builder
public static ListAuditEventAnalyticsRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
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 classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCode
in classBmcRequest<Void>
-
-