Package com.oracle.bmc.datasafe.requests

Class ListAuditEventsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListAuditEventsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAuditEventsRequest,Void>

Enclosing class:

ListAuditEventsRequest

public static class ListAuditEventsRequest.Builder
extends Object
implements BmcRequest.Builder<ListAuditEventsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListAuditEventsRequest.Builder	accessLevel(ListAuditEventsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListAuditEventsRequest	build()	Build the instance of ListAuditEventsRequest as configured by this builder
ListAuditEventsRequest	buildWithoutInvocationCallback()	Build the instance of ListAuditEventsRequest as configured by this builder
ListAuditEventsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListAuditEventsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListAuditEventsRequest.Builder	copy(ListAuditEventsRequest o)	Copy method to populate the builder with values from the given instance.
ListAuditEventsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListAuditEventsRequest.Builder	limit(Integer limit)	For details about how pagination works, see List Pagination.
ListAuditEventsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListAuditEventsRequest.Builder	page(String page)	It is usually retrieved from a previous “List” call.
ListAuditEventsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListAuditEventsRequest.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.
ListAuditEventsRequest.Builder	sortBy(ListAuditEventsRequest.SortBy sortBy)	If this query parameter is specified, the result is sorted by this query parameter value.
ListAuditEventsRequest.Builder	sortOrder(ListAuditEventsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

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$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListAuditEventsRequest.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 ListAuditEventsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

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

limit

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

scimQuery

public ListAuditEventsRequest.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:** (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)

Parameters:

scimQuery - the value to set

Returns:

this builder instance

sortOrder

public ListAuditEventsRequest.Builder sortOrder(ListAuditEventsRequest.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 ListAuditEventsRequest.Builder sortBy(ListAuditEventsRequest.SortBy sortBy)

If this query parameter is specified, the result is sorted by this query parameter value.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListAuditEventsRequest.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 ListAuditEventsRequest.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 ListAuditEventsRequest.Builder copy(ListAuditEventsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListAuditEventsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAuditEventsRequest build()

Build the instance of ListAuditEventsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListAuditEventsRequest,Void>

Returns:

instance of ListAuditEventsRequest

buildWithoutInvocationCallback

public ListAuditEventsRequest buildWithoutInvocationCallback()

Build the instance of ListAuditEventsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListAuditEventsRequest