Package com.oracle.bmc.identitydomains.requests

Class SearchUsersRequest.Builder

java.lang.Object

com.oracle.bmc.identitydomains.requests.SearchUsersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SearchUsersRequest,UserSearchRequest>

Enclosing class:

SearchUsersRequest

public static class SearchUsersRequest.Builder
extends Object
implements BmcRequest.Builder<SearchUsersRequest,UserSearchRequest>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchUsersRequest.Builder	authorization(String authorization)	The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
SearchUsersRequest.Builder	body$(UserSearchRequest body)	Alternative setter for the body parameter.
SearchUsersRequest	build()	Build the instance of SearchUsersRequest as configured by this builder
SearchUsersRequest	buildWithoutInvocationCallback()	Build the instance of SearchUsersRequest as configured by this builder
SearchUsersRequest.Builder	copy(SearchUsersRequest o)	Copy method to populate the builder with values from the given instance.
SearchUsersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
SearchUsersRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated ‘List’ call.
SearchUsersRequest.Builder	opcRetryToken(String opcRetryToken)	A token you supply to uniquely identify the request and provide idempotency if the request is retried.
SearchUsersRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous ‘List’ call.
SearchUsersRequest.Builder	resourceTypeSchemaVersion(String resourceTypeSchemaVersion)	An endpoint-specific schema version number to use in the Request.
SearchUsersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
SearchUsersRequest.Builder	userSearchRequest(UserSearchRequest userSearchRequest)	Parameters for searching Users

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authorization

public SearchUsersRequest.Builder authorization(String authorization)

The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

Parameters:

authorization - the value to set

Returns:

this builder instance

resourceTypeSchemaVersion

public SearchUsersRequest.Builder resourceTypeSchemaVersion(String resourceTypeSchemaVersion)

An endpoint-specific schema version number to use in the Request.

Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

Parameters:

resourceTypeSchemaVersion - the value to set

Returns:

this builder instance

userSearchRequest

public SearchUsersRequest.Builder userSearchRequest(UserSearchRequest userSearchRequest)

Parameters for searching Users

Parameters:

userSearchRequest - the value to set

Returns:

this builder instance

opcRetryToken

public SearchUsersRequest.Builder opcRetryToken(String opcRetryToken)

A token you supply to uniquely identify the request and provide idempotency if the request is retried.

Idempotency tokens expire after 24 hours.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

page

public SearchUsersRequest.Builder page(String page)

The value of the opc-next-page response header from the previous ‘List’ call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public SearchUsersRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated ‘List’ call.

Parameters:

limit - the value to set

Returns:

this builder instance

invocationCallback

public SearchUsersRequest.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 SearchUsersRequest.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 SearchUsersRequest.Builder copy(SearchUsersRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<SearchUsersRequest,UserSearchRequest>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SearchUsersRequest build()

Build the instance of SearchUsersRequest 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<SearchUsersRequest,UserSearchRequest>

Returns:

instance of SearchUsersRequest

body$

public SearchUsersRequest.Builder body$(UserSearchRequest body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<SearchUsersRequest,UserSearchRequest>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public SearchUsersRequest buildWithoutInvocationCallback()

Build the instance of SearchUsersRequest 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 SearchUsersRequest