ListUsersRequest.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.datasafe.requests.ListUsersRequest.Builder

All Implemented Interfaces:: BmcRequest.Builder<ListUsersRequest,Void>

Enclosing class:: ListUsersRequest

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

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListUsersRequest.Builder`	`accessLevel(ListUsersRequest.AccessLevel accessLevel)` Valid values are RESTRICTED and ACCESSIBLE.
`ListUsersRequest.Builder`	`accountStatus(String accountStatus)` A filter to return only items that match the specified account status.
`ListUsersRequest.Builder`	`areAllSchemasAccessible(Boolean areAllSchemasAccessible)` A filter to return only items that match the criteria that all schemas can be accessed by a user.
`ListUsersRequest.Builder`	`authenticationType(String authenticationType)` A filter to return only items that match the specified authentication type.
`ListUsersRequest`	`build()` Build the instance of ListUsersRequest as configured by this builder
`ListUsersRequest`	`buildWithoutInvocationCallback()` Build the instance of ListUsersRequest as configured by this builder
`ListUsersRequest.Builder`	`compartmentIdInSubtree(Boolean compartmentIdInSubtree)` Default is false.
`ListUsersRequest.Builder`	`copy(ListUsersRequest o)` Copy method to populate the builder with values from the given instance.
`ListUsersRequest.Builder`	`invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)` Set the invocation callback for the request to be built.
`ListUsersRequest.Builder`	`limit(Integer limit)` For list pagination.
`ListUsersRequest.Builder`	`opcRequestId(String opcRequestId)` Unique identifier for the request.
`ListUsersRequest.Builder`	`page(String page)` For list pagination.
`ListUsersRequest.Builder`	`retryConfiguration(RetryConfiguration retryConfiguration)` Set the retry configuration for the request to be built.
`ListUsersRequest.Builder`	`schemaList(List<String> schemaList)` A filter to return items that contain the specified schema list.
`ListUsersRequest.Builder`	`schemaList(String singularValue)` Singular setter.
`ListUsersRequest.Builder`	`sortBy(ListUsersRequest.SortBy sortBy)` The field to sort by.
`ListUsersRequest.Builder`	`sortOrder(ListUsersRequest.SortOrder sortOrder)` The sort order to use, either ascending (ASC) or descending (DESC).
`ListUsersRequest.Builder`	`targetId(String targetId)` A filter to return only items related to a specific target OCID.
`ListUsersRequest.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.
`ListUsersRequest.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.
`ListUsersRequest.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.
`ListUsersRequest.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.
`ListUsersRequest.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.
`ListUsersRequest.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.
`ListUsersRequest.Builder`	`userAssessmentId(String userAssessmentId)` The OCID of the user assessment.
`ListUsersRequest.Builder`	`userCategory(String userCategory)` A filter to return only items that match the specified user category.
`ListUsersRequest.Builder`	`userKey(String userKey)` A filter to return only items that match the specified user key.
`ListUsersRequest.Builder`	`userName(String userName)` A filter to return only items that match the specified user name.
`ListUsersRequest.Builder`	`userProfile(String userProfile)` A filter to return only items that match the specified user profile.
`ListUsersRequest.Builder`	`userRole(String userRole)` A filter to return only items that match the specified user role.
`ListUsersRequest.Builder`	`userType(String userType)` A filter to return only items that match the specified user type.

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
  - userAssessmentId
```
public ListUsersRequest.Builder userAssessmentId(String userAssessmentId)
```
    The OCID of the user assessment.
    
    Parameters:
    
    userAssessmentId - the value to set
    
    Returns:
    
    this builder instance
  - limit
```
public ListUsersRequest.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
  - compartmentIdInSubtree
```
public ListUsersRequest.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 ListUsersRequest.Builder accessLevel(ListUsersRequest.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
  - userCategory
```
public ListUsersRequest.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
  - userRole
```
public ListUsersRequest.Builder userRole(String userRole)
```
    A filter to return only items that match the specified user role.
    
    Parameters:
    
    userRole - the value to set
    
    Returns:
    
    this builder instance
  - userProfile
```
public ListUsersRequest.Builder userProfile(String userProfile)
```
    A filter to return only items that match the specified user profile.
    
    Parameters:
    
    userProfile - the value to set
    
    Returns:
    
    this builder instance
  - userType
```
public ListUsersRequest.Builder userType(String userType)
```
    A filter to return only items that match the specified user type. The possible values can be - ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED as specified by ‘#/definitions/userTypes’.
    
    Parameters:
    
    userType - the value to set
    
    Returns:
    
    this builder instance
  - userKey
```
public ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.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
  - page
```
public ListUsersRequest.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 ListUsersRequest.Builder sortOrder(ListUsersRequest.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 ListUsersRequest.Builder sortBy(ListUsersRequest.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 ListUsersRequest.Builder opcRequestId(String opcRequestId)
```
    Unique identifier for the request.
    
    Parameters:
    
    opcRequestId - the value to set
    
    Returns:
    
    this builder instance
  - schemaList
```
public ListUsersRequest.Builder schemaList(List<String> schemaList)
```
    A filter to return items that contain the specified schema list.
    
    Parameters:
    
    schemaList - the value to set
    
    Returns:
    
    this builder instance
  - schemaList
```
public ListUsersRequest.Builder schemaList(String singularValue)
```
    Singular setter. A filter to return items that contain the specified schema list.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - areAllSchemasAccessible
```
public ListUsersRequest.Builder areAllSchemasAccessible(Boolean areAllSchemasAccessible)
```
    A filter to return only items that match the criteria that all schemas can be accessed by a user.
    
    Parameters:
    
    areAllSchemasAccessible - the value to set
    
    Returns:
    
    this builder instance
  - invocationCallback
```
public ListUsersRequest.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 ListUsersRequest.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 ListUsersRequest.Builder copy(ListUsersRequest o)
```
    Copy method to populate the builder with values from the given instance.
    
    Specified by:
    
    copy in interface BmcRequest.Builder<ListUsersRequest,Void>
    
    Parameters:
    
    o - other request from which to copy values
    
    Returns:
    
    this builder instance
  - build
```
public ListUsersRequest build()
```
    Build the instance of ListUsersRequest 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<ListUsersRequest,Void>
    
    Returns:
    
    instance of ListUsersRequest
  - buildWithoutInvocationCallback
```
public ListUsersRequest buildWithoutInvocationCallback()
```
    Build the instance of ListUsersRequest 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 ListUsersRequest

Class ListUsersRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

Constructor Detail

Builder

Method Detail

userAssessmentId

limit

compartmentIdInSubtree

accessLevel

userCategory

userRole

userProfile

userType

userKey

accountStatus

authenticationType

userName

targetId

timeLastLoginGreaterThanOrEqualTo

timeLastLoginLessThan

timeUserCreatedGreaterThanOrEqualTo

timeUserCreatedLessThan

timePasswordLastChangedGreaterThanOrEqualTo

timePasswordLastChangedLessThan

page

sortOrder

sortBy

opcRequestId

schemaList

schemaList

areAllSchemasAccessible

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback