Package com.oracle.bmc.datacatalog.requests

Class UsersRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.UsersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<UsersRequest,Void>

Enclosing class:

UsersRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UsersRequest	build()	Build the instance of UsersRequest as configured by this builder
UsersRequest	buildWithoutInvocationCallback()	Build the instance of UsersRequest as configured by this builder
UsersRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
UsersRequest.Builder	copy(UsersRequest o)	Copy method to populate the builder with values from the given instance.
UsersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
UsersRequest.Builder	limit(Integer limit)	The maximum number of items to return.
UsersRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
UsersRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
UsersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
UsersRequest.Builder	sortBy(UsersRequest.SortBy sortBy)	The field to sort by.
UsersRequest.Builder	sortOrder(UsersRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.

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

catalogId

public UsersRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

sortBy

public UsersRequest.Builder sortBy(UsersRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public UsersRequest.Builder sortOrder(UsersRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public UsersRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public UsersRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public UsersRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<UsersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public UsersRequest build()

Build the instance of UsersRequest 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<UsersRequest,Void>

Returns:

instance of UsersRequest

buildWithoutInvocationCallback

public UsersRequest buildWithoutInvocationCallback()

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