com.oracle.bmc.identity.requests

Class ListUsersRequest.Builder

java.lang.Object

com.oracle.bmc.identity.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>

Method Summary

Modifier and Type	Method and Description
ListUsersRequest	build() Build the instance of ListUsersRequest as configured by this builder
ListUsersRequest	buildWithoutInvocationCallback()
ListUsersRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment (remember that the tenancy is simply the root compartment).
ListUsersRequest.Builder	copy(ListUsersRequest o) Copy method to populate the builder with values from the given instance.
ListUsersRequest.Builder	externalIdentifier(String externalIdentifier) The id of a user in the identity provider.
ListUsersRequest.Builder	identityProviderId(String identityProviderId) The id of the identity provider.
ListUsersRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListUsersRequest.Builder	lifecycleState(User.LifecycleState lifecycleState) A filter to only return resources that match the given lifecycle state.
ListUsersRequest.Builder	limit(Integer limit) The maximum number of items to return in a paginated “List” call.
ListUsersRequest.Builder	name(String name) A filter to only return resources that match the given name exactly.
ListUsersRequest.Builder	page(String page) The value of the opc-next-page response header from the previous “List” call.
ListUsersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
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).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

body$

Method Detail

invocationCallback

public ListUsersRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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.util.internal.Consumer) 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

compartmentId

public ListUsersRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment (remember that the tenancy is simply the root compartment).

Returns:

this.

page

public ListUsersRequest.Builder page(String page)

The value of the opc-next-page response header from the previous “List” call.

Returns:

this.

limit

public ListUsersRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated “List” call.

Returns:

this.

identityProviderId

public ListUsersRequest.Builder identityProviderId(String identityProviderId)

The id of the identity provider.

Returns:

this.

externalIdentifier

public ListUsersRequest.Builder externalIdentifier(String externalIdentifier)

The id of a user in the identity provider.

Returns:

this.

name

public ListUsersRequest.Builder name(String name)

A filter to only return resources that match the given name exactly.

Returns:

this.

sortBy

public ListUsersRequest.Builder sortBy(ListUsersRequest.SortBy sortBy)

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.

Returns:

this.

sortOrder

public ListUsersRequest.Builder sortOrder(ListUsersRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

Returns:

this.

lifecycleState

public ListUsersRequest.Builder lifecycleState(User.LifecycleState lifecycleState)

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:

this.

buildWithoutInvocationCallback

public ListUsersRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object