com.oracle.bmc.identity.requests

Class ListCompartmentsRequest

java.lang.Object

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

com.oracle.bmc.identity.requests.ListCompartmentsRequest

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

Example: Click here to see how to use ListCompartmentsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCompartmentsRequest.AccessLevel Valid values are ANY and ACCESSIBLE.
static class	ListCompartmentsRequest.Builder
static class	ListCompartmentsRequest.SortBy The field to sort by.
static class	ListCompartmentsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListCompartmentsRequest.Builder	builder()
ListCompartmentsRequest.AccessLevel	getAccessLevel() Valid values are ANY and ACCESSIBLE.
String	getCompartmentId() The OCID of the compartment (remember that the tenancy is simply the root compartment).
Boolean	getCompartmentIdInSubtree() Default is false.
Compartment.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() The maximum number of items to return in a paginated "List" call.
String	getName() A filter to only return resources that match the given name exactly.
String	getPage() The value of the opc-next-page response header from the previous "List" call.
ListCompartmentsRequest.SortBy	getSortBy() The field to sort by.
ListCompartmentsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListCompartmentsRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

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

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.

getAccessLevel

public ListCompartmentsRequest.AccessLevel getAccessLevel()

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.

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

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.

getName

public String getName()

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

getSortBy

public ListCompartmentsRequest.SortBy getSortBy()

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.

getSortOrder

public ListCompartmentsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

getLifecycleState

public Compartment.LifecycleState getLifecycleState()

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.