@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ListCompartmentsRequest extends BmcRequest
Modifier and Type | Class and Description |
---|---|
static class |
ListCompartmentsRequest.AccessLevel
Valid values are
ANY and ACCESSIBLE . |
static class |
ListCompartmentsRequest.Builder |
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.
|
Integer |
getLimit()
The maximum number of items to return in a paginated "List" call.
|
String |
getPage()
The value of the
opc-next-page response header from the previous "List" call. |
getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration
public static ListCompartmentsRequest.Builder builder()
public String getCompartmentId()
The OCID of the compartment (remember that the tenancy is simply the root compartment).
public String getPage()
The value of the opc-next-page
response header from the previous "List" call.
public Integer getLimit()
The maximum number of items to return in a paginated "List" call.
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.
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
.
Copyright © 2016–2019. All rights reserved.