Package com.oracle.bmc.identitydomains.requests

Class ListSchemasRequest.Builder

java.lang.Object

com.oracle.bmc.identitydomains.requests.ListSchemasRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSchemasRequest,Void>

Enclosing class:

ListSchemasRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSchemasRequest.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.
ListSchemasRequest	build()	Build the instance of ListSchemasRequest as configured by this builder
ListSchemasRequest	buildWithoutInvocationCallback()	Build the instance of ListSchemasRequest as configured by this builder
ListSchemasRequest.Builder	copy(ListSchemasRequest o)	Copy method to populate the builder with values from the given instance.
ListSchemasRequest.Builder	count(Integer count)	OPTIONAL.
ListSchemasRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSchemasRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated ‘List’ call.
ListSchemasRequest.Builder	opcRetryToken(String opcRetryToken)	A token you supply to uniquely identify the request and provide idempotency if the request is retried.
ListSchemasRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous ‘List’ call.
ListSchemasRequest.Builder	resourceTypeSchemaVersion(String resourceTypeSchemaVersion)	An endpoint-specific schema version number to use in the Request.
ListSchemasRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSchemasRequest.Builder	sortBy(String sortBy)	OPTIONAL.
ListSchemasRequest.Builder	sortOrder(SortOrder sortOrder)	A string that indicates the order in which the sortBy parameter is applied.
ListSchemasRequest.Builder	startIndex(Integer startIndex)	OPTIONAL.

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

sortBy

public ListSchemasRequest.Builder sortBy(String sortBy)

OPTIONAL.

A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3).

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListSchemasRequest.Builder sortOrder(SortOrder sortOrder)

A string that indicates the order in which the sortBy parameter is applied.

Allowed values are ‘ascending’ and ‘descending’. See (Sorting Section). OPTIONAL.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

startIndex

public ListSchemasRequest.Builder startIndex(Integer startIndex)

OPTIONAL.

An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on.

Parameters:

startIndex - the value to set

Returns:

this builder instance

count

public ListSchemasRequest.Builder count(Integer count)

OPTIONAL.

An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4).

Parameters:

count - the value to set

Returns:

this builder instance

authorization

public ListSchemasRequest.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 ListSchemasRequest.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

opcRetryToken

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSchemasRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSchemasRequest build()

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

Returns:

instance of ListSchemasRequest

buildWithoutInvocationCallback

public ListSchemasRequest buildWithoutInvocationCallback()

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