Class ListUsersRequest
- java.lang.Object
- 
- com.oracle.bmc.requests.BmcRequest<Void>
- 
- com.oracle.bmc.identity.requests.ListUsersRequest
 
 
- 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ListUsersRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/identity/ListUsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUsersRequest. 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classListUsersRequest.Builderstatic classListUsersRequest.SortByThe field to sort by.static classListUsersRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
 - 
Constructor SummaryConstructors Constructor Description ListUsersRequest()
 - 
Method SummaryAll 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’.StringgetCompartmentId()The OCID of the compartment (remember that the tenancy is simply the root compartment).StringgetExternalIdentifier()The id of a user in the identity provider.StringgetIdentityProviderId()The id of the identity provider.User.LifecycleStategetLifecycleState()A filter to only return resources that match the given lifecycle state.IntegergetLimit()The maximum number of items to return in a paginated “List” call.StringgetName()A filter to only return resources that match the given name exactly.StringgetPage()The value of the opc-next-page response header from the previous “List” call.ListUsersRequest.SortBygetSortBy()The field to sort by.ListUsersRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).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.BmcRequestgetBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
 
- 
 
- 
- 
- 
Method Detail- 
getCompartmentIdpublic String getCompartmentId() The OCID of the compartment (remember that the tenancy is simply the root compartment).
 - 
getPagepublic String getPage() The value of the opc-next-page response header from the previous “List” call.
 - 
getLimitpublic Integer getLimit() The maximum number of items to return in a paginated “List” call.
 - 
getIdentityProviderIdpublic String getIdentityProviderId() The id of the identity provider.
 - 
getExternalIdentifierpublic String getExternalIdentifier() The id of a user in the identity provider.
 - 
getNamepublic String getName() A filter to only return resources that match the given name exactly.
 - 
getSortBypublic ListUsersRequest.SortBy getSortBy() The field to sort by.You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. *Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted. 
 - 
getSortOrderpublic ListUsersRequest.SortOrder getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).The NAME sort order is case sensitive. 
 - 
getLifecycleStatepublic User.LifecycleState getLifecycleState() A filter to only return resources that match the given lifecycle state.The state value is case-insensitive. 
 - 
toBuilderpublic 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.
 
 - 
builderpublic static ListUsersRequest.Builder builder() Return a new builder for this request object.- Returns:
- builder for the request object
 
 - 
equalspublic boolean equals(Object o) Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
- equalsin class- BmcRequest<Void>
 
 - 
hashCodepublic int hashCode() Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
- hashCodein class- BmcRequest<Void>
 
 
- 
 
-