Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListCompartmentsRequest

example

Click here to see how to use ListCompartmentsRequest.

Properties

Optional accessLevel

accessLevel: AccessLevel

Valid values are {@code ANY} and {@code ACCESSIBLE}. Default is {@code ANY}. Setting this to {@code 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 {@code ANY} permissions are not checked.

compartmentId

compartmentId: string

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

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

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 {@code accessLevel}.

Optional lifecycleState

lifecycleState: undefined | string

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

Optional limit

limit: undefined | number

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

Optional name

name: undefined | string

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

Optional page

page: undefined | string

The value of the {@code opc-next-page} response header from the previous "List" call.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. You can provide one sort order ({@code 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, {@code 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.

Optional sortOrder

sortOrder: SortOrder

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