public static class ListCategoriesRequest.Builder extends Object implements BmcRequest.Builder<ListCategoriesRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListCategoriesRequest |
build()
Build the instance of ListCategoriesRequest as configured by this builder
|
ListCategoriesRequest |
buildWithoutInvocationCallback()
Build the instance of ListCategoriesRequest as configured by this builder
|
ListCategoriesRequest.Builder |
childTenancyIds(List<String> childTenancyIds)
A list of child tenancies for which the respective data will be returned.
|
ListCategoriesRequest.Builder |
childTenancyIds(String singularValue)
Singular setter.
|
ListCategoriesRequest.Builder |
compartmentId(String compartmentId)
The OCID of the compartment.
|
ListCategoriesRequest.Builder |
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
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 . |
ListCategoriesRequest.Builder |
copy(ListCategoriesRequest o)
Copy method to populate the builder with values from the given instance.
|
ListCategoriesRequest.Builder |
includeOrganization(Boolean includeOrganization)
When set to true, the data for all child tenancies including the parent is returned.
|
ListCategoriesRequest.Builder |
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
|
ListCategoriesRequest.Builder |
lifecycleState(LifecycleState lifecycleState)
A filter that returns results that match the lifecycle state specified.
|
ListCategoriesRequest.Builder |
limit(Integer limit)
The maximum number of items to return in a paginated “List” call.
|
ListCategoriesRequest.Builder |
name(String name)
Optional.
|
ListCategoriesRequest.Builder |
opcRequestId(String opcRequestId)
Unique Oracle-assigned identifier for the request.
|
ListCategoriesRequest.Builder |
page(String page)
The value of the
opc-next-page response header from the previous “List” call. |
ListCategoriesRequest.Builder |
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
|
ListCategoriesRequest.Builder |
sortBy(ListCategoriesRequest.SortBy sortBy)
The field to sort by.
|
ListCategoriesRequest.Builder |
sortOrder(SortOrder sortOrder)
The sort order to use, either ascending (
ASC ) or descending (DESC ). |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListCategoriesRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.
compartmentId
- the value to setpublic ListCategoriesRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
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
.
Can only be set to true when performing ListCompartments on the tenancy (root compartment).
compartmentIdInSubtree
- the value to setpublic ListCategoriesRequest.Builder childTenancyIds(List<String> childTenancyIds)
A list of child tenancies for which the respective data will be returned. Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.
If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.
It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
childTenancyIds
- the value to setpublic ListCategoriesRequest.Builder childTenancyIds(String singularValue)
Singular setter. A list of child tenancies for which the respective data will be returned. Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.
If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.
It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
singularValue
- the singular value to setpublic ListCategoriesRequest.Builder includeOrganization(Boolean includeOrganization)
When set to true, the data for all child tenancies including the parent is returned. That is, if there is an organization with parent P and children A and B, to return the data for the parent P, child A and child B, this parameter value should be set to true.
Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
includeOrganization
- the value to setpublic ListCategoriesRequest.Builder name(String name)
Optional. A filter that returns results that match the name specified.
name
- the value to setpublic ListCategoriesRequest.Builder limit(Integer limit)
The maximum number of items to return in a paginated “List” call.
limit
- the value to setpublic ListCategoriesRequest.Builder page(String page)
The value of the opc-next-page
response header from the previous “List” call.
page
- the value to setpublic ListCategoriesRequest.Builder sortOrder(SortOrder sortOrder)
The sort order to use, either ascending (ASC
) or descending (DESC
).
sortOrder
- the value to setpublic ListCategoriesRequest.Builder sortBy(ListCategoriesRequest.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.
sortBy
- the value to setpublic ListCategoriesRequest.Builder lifecycleState(LifecycleState lifecycleState)
A filter that returns results that match the lifecycle state specified.
lifecycleState
- the value to setpublic ListCategoriesRequest.Builder opcRequestId(String opcRequestId)
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opcRequestId
- the value to setpublic ListCategoriesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListCategoriesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListCategoriesRequest.Builder copy(ListCategoriesRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListCategoriesRequest,Void>
o
- other request from which to copy valuespublic ListCategoriesRequest build()
Build the instance of ListCategoriesRequest 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.
build
in interface BmcRequest.Builder<ListCategoriesRequest,Void>
public ListCategoriesRequest buildWithoutInvocationCallback()
Build the instance of ListCategoriesRequest 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
Copyright © 2016–2024. All rights reserved.