com.oracle.bmc.identitydomains.requests

Class ListPoliciesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.identitydomains.requests.ListPoliciesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public class ListPoliciesRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListPoliciesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListPoliciesRequest.Builder

Constructor Summary

Constructors

Constructor and Description
ListPoliciesRequest()

Method Summary

Modifier and Type	Method and Description
static ListPoliciesRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getAttributes() A comma-delimited string that specifies the names of resource attributes that should be returned in the response.
List<AttributeSets>	getAttributeSets() A multi-valued list of strings indicating the return type of attribute definition.
String	getAuthorization() The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
Integer	getCount() OPTIONAL.
String	getFilter() OPTIONAL.
Integer	getLimit() The maximum number of items to return in a paginated ‘List’ call.
String	getOpcRetryToken() A token you supply to uniquely identify the request and provide idempotency if the request is retried.
String	getPage() The value of the opc-next-page response header from the previous ‘List’ call.
String	getResourceTypeSchemaVersion() An endpoint-specific schema version number to use in the Request.
String	getSortBy() OPTIONAL.
SortOrder	getSortOrder() A string that indicates the order in which the sortBy parameter is applied.
Integer	getStartIndex() OPTIONAL.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListPoliciesRequest.Builder	toBuilder() Return an instance of ListPoliciesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPoliciesRequest

public ListPoliciesRequest()

Method Detail

getFilter

public String getFilter()

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.

getSortBy

public String getSortBy()

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).

getSortOrder

public SortOrder getSortOrder()

A string that indicates the order in which the sortBy parameter is applied. Allowed values are ‘ascending’ and ‘descending’. See (Sorting Section). OPTIONAL.

getStartIndex

public Integer getStartIndex()

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.

getCount

public Integer getCount()

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).

getAttributes

public String getAttributes()

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.

getAttributeSets

public List<AttributeSets> getAttributeSets()

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.

getAuthorization

public String getAuthorization()

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

getResourceTypeSchemaVersion

public String getResourceTypeSchemaVersion()

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.

getOpcRetryToken

public String getOpcRetryToken()

A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

getPage

public String getPage()

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

getLimit

public Integer getLimit()

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

toBuilder

public ListPoliciesRequest.Builder toBuilder()

Return an instance of ListPoliciesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListPoliciesRequest.Builder that allows you to modify request properties.

builder

public static ListPoliciesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>