Class ListUsersRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListUsersRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListUsersRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListUsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUsersRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListUsersRequest.AccessLevelValid values are RESTRICTED and ACCESSIBLE.static classListUsersRequest.Builderstatic classListUsersRequest.SortByThe field to sort by.static classListUsersRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListUsersRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListUsersRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListUsersRequest.AccessLevelgetAccessLevel()Valid values are RESTRICTED and ACCESSIBLE.StringgetAccountStatus()A filter to return only items that match the specified account status.BooleangetAreAllSchemasAccessible()A filter to return only items that match the criteria that all schemas can be accessed by a user.StringgetAuthenticationType()A filter to return only items that match the specified authentication type.BooleangetCompartmentIdInSubtree()Default is false.IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.List<String>getSchemaList()A filter to return items that contain the specified schema list.ListUsersRequest.SortBygetSortBy()The field to sort by.ListUsersRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetTargetId()A filter to return only items related to a specific target OCID.DategetTimeLastLoginGreaterThanOrEqualTo()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.DategetTimeLastLoginLessThan()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.DategetTimePasswordExpiryGreaterThanOrEqualTo()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.DategetTimePasswordExpiryLessThan()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.DategetTimePasswordLastChangedGreaterThanOrEqualTo()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.DategetTimePasswordLastChangedLessThan()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.DategetTimeUserCreatedGreaterThanOrEqualTo()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.DategetTimeUserCreatedLessThan()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.StringgetUserAssessmentId()The OCID of the user assessment.StringgetUserCategory()A filter to return only items that match the specified user category.StringgetUserKey()A filter to return only items that match the specified user key.StringgetUserName()A filter to return only items that match the specified user name.StringgetUserProfile()A filter to return only items that match the specified user profile.StringgetUserRole()A filter to return only items that match the specified user role.StringgetUserType()A filter to return only items that match the specified user type.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListUsersRequest.BuildertoBuilder()Return an instance ofListUsersRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getUserAssessmentId
public String getUserAssessmentId()
The OCID of the user assessment.
-
getLimit
public Integer getLimit()
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.
-
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 ListUsersRequest.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.
-
getUserCategory
public String getUserCategory()
A filter to return only items that match the specified user category.
-
getUserRole
public String getUserRole()
A filter to return only items that match the specified user role.
-
getUserProfile
public String getUserProfile()
A filter to return only items that match the specified user profile.
-
getUserType
public String getUserType()
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’.
-
getUserKey
public String getUserKey()
A filter to return only items that match the specified user key.
-
getAccountStatus
public String getAccountStatus()
A filter to return only items that match the specified account status.
-
getAuthenticationType
public String getAuthenticationType()
A filter to return only items that match the specified authentication type.
-
getUserName
public String getUserName()
A filter to return only items that match the specified user name.
-
getTargetId
public String getTargetId()
A filter to return only items related to a specific target OCID.
-
getTimeLastLoginGreaterThanOrEqualTo
public Date getTimeLastLoginGreaterThanOrEqualTo()
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
-
getTimeLastLoginLessThan
public Date getTimeLastLoginLessThan()
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
-
getTimeUserCreatedGreaterThanOrEqualTo
public Date getTimeUserCreatedGreaterThanOrEqualTo()
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
-
getTimeUserCreatedLessThan
public Date getTimeUserCreatedLessThan()
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
-
getTimePasswordLastChangedGreaterThanOrEqualTo
public Date getTimePasswordLastChangedGreaterThanOrEqualTo()
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
-
getTimePasswordLastChangedLessThan
public Date getTimePasswordLastChangedLessThan()
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
-
getTimePasswordExpiryGreaterThanOrEqualTo
public Date getTimePasswordExpiryGreaterThanOrEqualTo()
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
-
getTimePasswordExpiryLessThan
public Date getTimePasswordExpiryLessThan()
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
-
getPage
public String getPage()
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.
-
getSortOrder
public ListUsersRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListUsersRequest.SortBy getSortBy()
The field to sort by.You can specify only one sort order (sortOrder). The default order for userName is ascending.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
getSchemaList
public List<String> getSchemaList()
A filter to return items that contain the specified schema list.
-
getAreAllSchemasAccessible
public Boolean getAreAllSchemasAccessible()
A filter to return only items that match the criteria that all schemas can be accessed by a user.
-
toBuilder
public ListUsersRequest.Builder toBuilder()
Return an instance ofListUsersRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListUsersRequest.Builderthat allows you to modify request properties.
-
builder
public static ListUsersRequest.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:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-