Package com.oracle.bmc.databasemanagement.requests

Class ListUsersRequest.Builder

java.lang.Object

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListUsersRequest	build()	Build the instance of ListUsersRequest as configured by this builder
ListUsersRequest	buildWithoutInvocationCallback()	Build the instance of ListUsersRequest as configured by this builder
ListUsersRequest.Builder	copy(ListUsersRequest o)	Copy method to populate the builder with values from the given instance.
ListUsersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListUsersRequest.Builder	limit(Integer limit)	The maximum number of records returned in the paginated response.
ListUsersRequest.Builder	managedDatabaseId(String managedDatabaseId)	The OCID of the Managed Database.
ListUsersRequest.Builder	name(String name)	A filter to return only resources that match the entire name.
ListUsersRequest.Builder	opcNamedCredentialId(String opcNamedCredentialId)	The OCID of the Named Credential.
ListUsersRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListUsersRequest.Builder	page(String page)	The page token representing the page from where the next set of paginated results are retrieved.
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 information by.
ListUsersRequest.Builder	sortOrder(SortOrders sortOrder)	The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order.

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

managedDatabaseId

public ListUsersRequest.Builder managedDatabaseId(String managedDatabaseId)

The OCID of the Managed Database.

Parameters:

managedDatabaseId - the value to set

Returns:

this builder instance

opcRequestId

public ListUsersRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

name

public ListUsersRequest.Builder name(String name)

A filter to return only resources that match the entire name.

Parameters:

name - the value to set

Returns:

this builder instance

sortBy

public ListUsersRequest.Builder sortBy(ListUsersRequest.SortBy sortBy)

The field to sort information by.

Only one sortOrder can be used. The default sort order for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListUsersRequest.Builder sortOrder(SortOrders sortOrder)

The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order.

Ascending order is the default order.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListUsersRequest.Builder limit(Integer limit)

The maximum number of records returned in the paginated response.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListUsersRequest.Builder page(String page)

The page token representing the page from where the next set of paginated results are retrieved.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

opcNamedCredentialId

public ListUsersRequest.Builder opcNamedCredentialId(String opcNamedCredentialId)

The OCID of the Named Credential.

Parameters:

opcNamedCredentialId - the value to set

Returns:

this builder instance

invocationCallback

public ListUsersRequest.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 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.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<ListUsersRequest,Void>

Returns:

instance of ListUsersRequest

buildWithoutInvocationCallback

public ListUsersRequest buildWithoutInvocationCallback()

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