Package com.oracle.bmc.identity.requests

Class ListCompartmentsRequest.Builder

java.lang.Object

com.oracle.bmc.identity.requests.ListCompartmentsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCompartmentsRequest,Void>

Enclosing class:

ListCompartmentsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

accessLevel

public ListCompartmentsRequest.Builder accessLevel(ListCompartmentsRequest.AccessLevel accessLevel)

Valid values are ANY and ACCESSIBLE.

Default is ANY. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). For the compartments on which the user indirectly has INSPECT permissions, a restricted set of fields is returned.

When set to ANY permissions are not checked.

Parameters:

accessLevel - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListCompartmentsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false.

Can only be set to true when performing ListCompartments on the tenancy (root compartment). When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

name

public ListCompartmentsRequest.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 ListCompartmentsRequest.Builder sortBy(ListCompartmentsRequest.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 ListCompartmentsRequest.Builder sortOrder(ListCompartmentsRequest.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 ListCompartmentsRequest.Builder lifecycleState(Compartment.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 ListCompartmentsRequest.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 ListCompartmentsRequest.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 ListCompartmentsRequest.Builder copy(ListCompartmentsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListCompartmentsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCompartmentsRequest build()

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

Returns:

instance of ListCompartmentsRequest

buildWithoutInvocationCallback

public ListCompartmentsRequest buildWithoutInvocationCallback()

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