Package com.oracle.bmc.identity.requests

Class ListPoliciesRequest.Builder

java.lang.Object

com.oracle.bmc.identity.requests.ListPoliciesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPoliciesRequest,Void>

Enclosing class:

ListPoliciesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPoliciesRequest	build()	Build the instance of ListPoliciesRequest as configured by this builder
ListPoliciesRequest	buildWithoutInvocationCallback()	Build the instance of ListPoliciesRequest as configured by this builder
ListPoliciesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment (remember that the tenancy is simply the root compartment).
ListPoliciesRequest.Builder	copy(ListPoliciesRequest o)	Copy method to populate the builder with values from the given instance.
ListPoliciesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPoliciesRequest.Builder	lifecycleState(Policy.LifecycleState lifecycleState)	A filter to only return resources that match the given lifecycle state.
ListPoliciesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListPoliciesRequest.Builder	name(String name)	A filter to only return resources that match the given name exactly.
ListPoliciesRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListPoliciesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPoliciesRequest.Builder	sortBy(ListPoliciesRequest.SortBy sortBy)	The field to sort by.
ListPoliciesRequest.Builder	sortOrder(ListPoliciesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (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

compartmentId

public ListPoliciesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment (remember that the tenancy is simply the root compartment).

Parameters:

compartmentId - the value to set

Returns:

this builder instance

page

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

name

public ListPoliciesRequest.Builder name(String name)

A filter to only return resources that match the given name exactly.

Parameters:

name - the value to set

Returns:

this builder instance

sortBy

public ListPoliciesRequest.Builder sortBy(ListPoliciesRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListPoliciesRequest.Builder sortOrder(ListPoliciesRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

The NAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListPoliciesRequest.Builder lifecycleState(Policy.LifecycleState lifecycleState)

A filter to only return resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListPoliciesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPoliciesRequest build()

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

Returns:

instance of ListPoliciesRequest

buildWithoutInvocationCallback

public ListPoliciesRequest buildWithoutInvocationCallback()

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