com.oracle.bmc.identitydomains.requests

Class ListRulesRequest.Builder

java.lang.Object

com.oracle.bmc.identitydomains.requests.ListRulesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRulesRequest,Void>

Enclosing class:

ListRulesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

filter

public ListRulesRequest.Builder filter(String filter)

OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

Parameters:

filter - the value to set

Returns:

this builder instance

sortBy

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

attributes

public ListRulesRequest.Builder attributes(String attributes)

A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

Parameters:

attributes - the value to set

Returns:

this builder instance

attributeSets

public ListRulesRequest.Builder attributeSets(List<AttributeSets> attributeSets)

A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If ‘attributes’ query parameter is also available, union of the two is fetched. Valid values

• all, always, never, request, default. Values are case-insensitive.

Parameters:

attributeSets - the value to set

Returns:

this builder instance

attributeSets

public ListRulesRequest.Builder attributeSets(AttributeSets singularValue)

Singular setter. A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If ‘attributes’ query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

authorization

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

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

Specified by:

copy in interface BmcRequest.Builder<ListRulesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRulesRequest build()

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

Returns:

instance of ListRulesRequest

buildWithoutInvocationCallback

public ListRulesRequest buildWithoutInvocationCallback()

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