Class ListAuditEventAnalyticsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListAuditEventAnalyticsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListAuditEventAnalyticsRequest,Void>
- Enclosing class:
- ListAuditEventAnalyticsRequest
public static class ListAuditEventAnalyticsRequest.Builder extends Object implements BmcRequest.Builder<ListAuditEventAnalyticsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListAuditEventAnalyticsRequest.BuilderaccessLevel(ListAuditEventAnalyticsRequest.AccessLevel accessLevel)Valid values are RESTRICTED and ACCESSIBLE.ListAuditEventAnalyticsRequestbuild()Build the instance of ListAuditEventAnalyticsRequest as configured by this builderListAuditEventAnalyticsRequestbuildWithoutInvocationCallback()Build the instance of ListAuditEventAnalyticsRequest as configured by this builderListAuditEventAnalyticsRequest.BuildercompartmentId(String compartmentId)A filter to return only resources that match the specified compartment OCID.ListAuditEventAnalyticsRequest.BuildercompartmentIdInSubtree(Boolean compartmentIdInSubtree)Default is false.ListAuditEventAnalyticsRequest.Buildercopy(ListAuditEventAnalyticsRequest o)Copy method to populate the builder with values from the given instance.ListAuditEventAnalyticsRequest.BuildergroupBy(ListAuditEventAnalyticsRequest.GroupBy singularValue)Singular setter.ListAuditEventAnalyticsRequest.BuildergroupBy(List<ListAuditEventAnalyticsRequest.GroupBy> groupBy)A groupBy can only be used in combination with summaryField parameter.ListAuditEventAnalyticsRequest.BuilderifMatch(String ifMatch)For optimistic concurrency control.ListAuditEventAnalyticsRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListAuditEventAnalyticsRequest.Builderlimit(Integer limit)For details about how pagination works, see List Pagination.ListAuditEventAnalyticsRequest.BuilderopcRequestId(String opcRequestId)Unique identifier for the request.ListAuditEventAnalyticsRequest.BuilderopcRetryToken(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.ListAuditEventAnalyticsRequest.Builderpage(String page)It is usually retrieved from a previous “List” call.ListAuditEventAnalyticsRequest.BuilderqueryTimeZone(String queryTimeZone)Default time zone is UTC if no time zone provided.ListAuditEventAnalyticsRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListAuditEventAnalyticsRequest.BuilderscimQuery(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.ListAuditEventAnalyticsRequest.BuildersortBy(ListAuditEventAnalyticsRequest.SortBy sortBy)If this query parameter is specified, the result is ordered based on this query parameter value.ListAuditEventAnalyticsRequest.BuildersortOrder(ListAuditEventAnalyticsRequest.SortOrder sortOrder)The sort order to use, either ascending (ASC) or descending (DESC).ListAuditEventAnalyticsRequest.BuildersummaryField(ListAuditEventAnalyticsRequest.SummaryField singularValue)Singular setter.ListAuditEventAnalyticsRequest.BuildersummaryField(List<ListAuditEventAnalyticsRequest.SummaryField> summaryField)Specifies a subset of summarized fields to be returned in the response.ListAuditEventAnalyticsRequest.BuildertimeEnded(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.ListAuditEventAnalyticsRequest.BuildertimeStarted(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.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$
-
-
-
-
Method Detail
-
compartmentId
public ListAuditEventAnalyticsRequest.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
-
opcRequestId
public ListAuditEventAnalyticsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
ifMatch
public ListAuditEventAnalyticsRequest.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
-
limit
public ListAuditEventAnalyticsRequest.Builder limit(Integer limit)
For details about how pagination works, see List Pagination.- Parameters:
limit- the value to set- Returns:
- this builder instance
-
page
public ListAuditEventAnalyticsRequest.Builder page(String page)
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
-
compartmentIdInSubtree
public ListAuditEventAnalyticsRequest.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
-
accessLevel
public ListAuditEventAnalyticsRequest.Builder accessLevel(ListAuditEventAnalyticsRequest.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 ListAuditEventAnalyticsRequest.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:** (auditEventTime ge "2021-06-04T01:00:26.000Z") 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)
- Parameters:
scimQuery- the value to set- Returns:
- this builder instance
-
summaryField
public ListAuditEventAnalyticsRequest.Builder summaryField(List<ListAuditEventAnalyticsRequest.SummaryField> summaryField)
Specifies a subset of summarized fields to be returned in the response.- Parameters:
summaryField- the value to set- Returns:
- this builder instance
-
summaryField
public ListAuditEventAnalyticsRequest.Builder summaryField(ListAuditEventAnalyticsRequest.SummaryField singularValue)
Singular setter.Specifies a subset of summarized fields to be returned in the response.
- Parameters:
singularValue- the singular value to set- Returns:
- this builder instance
-
timeStarted
public ListAuditEventAnalyticsRequest.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 ListAuditEventAnalyticsRequest.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 ListAuditEventAnalyticsRequest.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
-
groupBy
public ListAuditEventAnalyticsRequest.Builder groupBy(List<ListAuditEventAnalyticsRequest.GroupBy> groupBy)
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:
groupBy- the value to set- Returns:
- this builder instance
-
groupBy
public ListAuditEventAnalyticsRequest.Builder groupBy(ListAuditEventAnalyticsRequest.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 ListAuditEventAnalyticsRequest.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
-
sortOrder
public ListAuditEventAnalyticsRequest.Builder sortOrder(ListAuditEventAnalyticsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder- the value to set- Returns:
- this builder instance
-
sortBy
public ListAuditEventAnalyticsRequest.Builder sortBy(ListAuditEventAnalyticsRequest.SortBy sortBy)
If this query parameter is specified, the result is ordered based on this query parameter value.- Parameters:
sortBy- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListAuditEventAnalyticsRequest.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 ListAuditEventAnalyticsRequest.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
-
copy
public ListAuditEventAnalyticsRequest.Builder copy(ListAuditEventAnalyticsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListAuditEventAnalyticsRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListAuditEventAnalyticsRequest build()
Build the instance of ListAuditEventAnalyticsRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuildWithoutInvocationCallback()does not.This is the preferred method to build an instance.
- Specified by:
buildin interfaceBmcRequest.Builder<ListAuditEventAnalyticsRequest,Void>- Returns:
- instance of ListAuditEventAnalyticsRequest
-
buildWithoutInvocationCallback
public ListAuditEventAnalyticsRequest buildWithoutInvocationCallback()
Build the instance of ListAuditEventAnalyticsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuild()does- Returns:
- instance of ListAuditEventAnalyticsRequest
-
-