Class ListUserAnalyticsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListUserAnalyticsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListUserAnalyticsRequest,Void>
- Enclosing class:
- ListUserAnalyticsRequest
public static class ListUserAnalyticsRequest.Builder extends Object implements BmcRequest.Builder<ListUserAnalyticsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListUserAnalyticsRequest.Builder
accessLevel(ListUserAnalyticsRequest.AccessLevel accessLevel)
Valid values are RESTRICTED and ACCESSIBLE.ListUserAnalyticsRequest.Builder
accountStatus(String accountStatus)
A filter to return only items that match the specified account status.ListUserAnalyticsRequest.Builder
authenticationType(String authenticationType)
A filter to return only items that match the specified authentication type.ListUserAnalyticsRequest
build()
Build the instance of ListUserAnalyticsRequest as configured by this builderListUserAnalyticsRequest
buildWithoutInvocationCallback()
Build the instance of ListUserAnalyticsRequest as configured by this builderListUserAnalyticsRequest.Builder
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
Default is false.ListUserAnalyticsRequest.Builder
copy(ListUserAnalyticsRequest o)
Copy method to populate the builder with values from the given instance.ListUserAnalyticsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListUserAnalyticsRequest.Builder
limit(Integer limit)
For list pagination.ListUserAnalyticsRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListUserAnalyticsRequest.Builder
page(String page)
For list pagination.ListUserAnalyticsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListUserAnalyticsRequest.Builder
sortBy(ListUserAnalyticsRequest.SortBy sortBy)
The field to sort by.ListUserAnalyticsRequest.Builder
sortOrder(ListUserAnalyticsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).ListUserAnalyticsRequest.Builder
targetId(String targetId)
A filter to return only items related to a specific target OCID.ListUserAnalyticsRequest.Builder
timeLastLoginGreaterThanOrEqualTo(Date timeLastLoginGreaterThanOrEqualTo)
A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timeLastLoginLessThan(Date timeLastLoginLessThan)
A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timePasswordExpiryGreaterThanOrEqualTo(Date timePasswordExpiryGreaterThanOrEqualTo)
A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timePasswordExpiryLessThan(Date timePasswordExpiryLessThan)
A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timePasswordLastChangedGreaterThanOrEqualTo(Date timePasswordLastChangedGreaterThanOrEqualTo)
A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timePasswordLastChangedLessThan(Date timePasswordLastChangedLessThan)
A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timeUserCreatedGreaterThanOrEqualTo(Date timeUserCreatedGreaterThanOrEqualTo)
A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
timeUserCreatedLessThan(Date timeUserCreatedLessThan)
A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339.ListUserAnalyticsRequest.Builder
userAssessmentId(String userAssessmentId)
The OCID of the user assessment.ListUserAnalyticsRequest.Builder
userCategory(String userCategory)
A filter to return only items that match the specified user category.ListUserAnalyticsRequest.Builder
userKey(String userKey)
A filter to return only items that match the specified user key.ListUserAnalyticsRequest.Builder
userName(String userName)
A filter to return only items that match the specified user name.-
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
-
userAssessmentId
public ListUserAnalyticsRequest.Builder userAssessmentId(String userAssessmentId)
The OCID of the user assessment.- Parameters:
userAssessmentId
- the value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListUserAnalyticsRequest.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 ListUserAnalyticsRequest.Builder accessLevel(ListUserAnalyticsRequest.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 ListUserAnalyticsRequest.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
-
userCategory
public ListUserAnalyticsRequest.Builder userCategory(String userCategory)
A filter to return only items that match the specified user category.- Parameters:
userCategory
- the value to set- Returns:
- this builder instance
-
userKey
public ListUserAnalyticsRequest.Builder userKey(String userKey)
A filter to return only items that match the specified user key.- Parameters:
userKey
- the value to set- Returns:
- this builder instance
-
accountStatus
public ListUserAnalyticsRequest.Builder accountStatus(String accountStatus)
A filter to return only items that match the specified account status.- Parameters:
accountStatus
- the value to set- Returns:
- this builder instance
-
authenticationType
public ListUserAnalyticsRequest.Builder authenticationType(String authenticationType)
A filter to return only items that match the specified authentication type.- Parameters:
authenticationType
- the value to set- Returns:
- this builder instance
-
userName
public ListUserAnalyticsRequest.Builder userName(String userName)
A filter to return only items that match the specified user name.- Parameters:
userName
- the value to set- Returns:
- this builder instance
-
targetId
public ListUserAnalyticsRequest.Builder targetId(String targetId)
A filter to return only items related to a specific target OCID.- Parameters:
targetId
- the value to set- Returns:
- this builder instance
-
timeLastLoginGreaterThanOrEqualTo
public ListUserAnalyticsRequest.Builder timeLastLoginGreaterThanOrEqualTo(Date timeLastLoginGreaterThanOrEqualTo)
A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.*Example:** 2016-12-19T16:39:57.600Z
- Parameters:
timeLastLoginGreaterThanOrEqualTo
- the value to set- Returns:
- this builder instance
-
timeLastLoginLessThan
public ListUserAnalyticsRequest.Builder timeLastLoginLessThan(Date timeLastLoginLessThan)
A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339.Example: 2016-12-19T16:39:57.600Z
- Parameters:
timeLastLoginLessThan
- the value to set- Returns:
- this builder instance
-
timeUserCreatedGreaterThanOrEqualTo
public ListUserAnalyticsRequest.Builder timeUserCreatedGreaterThanOrEqualTo(Date timeUserCreatedGreaterThanOrEqualTo)
A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.Example: 2016-12-19T16:39:57.600Z
- Parameters:
timeUserCreatedGreaterThanOrEqualTo
- the value to set- Returns:
- this builder instance
-
timeUserCreatedLessThan
public ListUserAnalyticsRequest.Builder timeUserCreatedLessThan(Date timeUserCreatedLessThan)
A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339.Example: 2016-12-19T16:39:57.600Z
- Parameters:
timeUserCreatedLessThan
- the value to set- Returns:
- this builder instance
-
timePasswordLastChangedGreaterThanOrEqualTo
public ListUserAnalyticsRequest.Builder timePasswordLastChangedGreaterThanOrEqualTo(Date timePasswordLastChangedGreaterThanOrEqualTo)
A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.*Example:** 2016-12-19T16:39:57.600Z
- Parameters:
timePasswordLastChangedGreaterThanOrEqualTo
- the value to set- Returns:
- this builder instance
-
timePasswordLastChangedLessThan
public ListUserAnalyticsRequest.Builder timePasswordLastChangedLessThan(Date timePasswordLastChangedLessThan)
A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.*Example:** 2016-12-19T16:39:57.600Z
- Parameters:
timePasswordLastChangedLessThan
- the value to set- Returns:
- this builder instance
-
timePasswordExpiryGreaterThanOrEqualTo
public ListUserAnalyticsRequest.Builder timePasswordExpiryGreaterThanOrEqualTo(Date timePasswordExpiryGreaterThanOrEqualTo)
A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.Example: 2016-12-19T16:39:57.600Z
- Parameters:
timePasswordExpiryGreaterThanOrEqualTo
- the value to set- Returns:
- this builder instance
-
timePasswordExpiryLessThan
public ListUserAnalyticsRequest.Builder timePasswordExpiryLessThan(Date timePasswordExpiryLessThan)
A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339.Example: 2016-12-19T16:39:57.600Z
- Parameters:
timePasswordExpiryLessThan
- the value to set- Returns:
- this builder instance
-
page
public ListUserAnalyticsRequest.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
-
sortOrder
public ListUserAnalyticsRequest.Builder sortOrder(ListUserAnalyticsRequest.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 ListUserAnalyticsRequest.Builder sortBy(ListUserAnalyticsRequest.SortBy sortBy)
The field to sort by.You can specify only one sort order (sortOrder). The default order for userName is ascending.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListUserAnalyticsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListUserAnalyticsRequest.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 ListUserAnalyticsRequest.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 ListUserAnalyticsRequest.Builder copy(ListUserAnalyticsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListUserAnalyticsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListUserAnalyticsRequest build()
Build the instance of ListUserAnalyticsRequest 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:
build
in interfaceBmcRequest.Builder<ListUserAnalyticsRequest,Void>
- Returns:
- instance of ListUserAnalyticsRequest
-
buildWithoutInvocationCallback
public ListUserAnalyticsRequest buildWithoutInvocationCallback()
Build the instance of ListUserAnalyticsRequest 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 ListUserAnalyticsRequest
-
-