Class ListInstancePoolsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.core.requests.ListInstancePoolsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListInstancePoolsRequest,Void>
- Enclosing class:
- ListInstancePoolsRequest
public static class ListInstancePoolsRequest.Builder extends Object implements BmcRequest.Builder<ListInstancePoolsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListInstancePoolsRequest
build()
Build the instance of ListInstancePoolsRequest as configured by this builderListInstancePoolsRequest
buildWithoutInvocationCallback()
Build the instance of ListInstancePoolsRequest as configured by this builderListInstancePoolsRequest.Builder
compartmentId(String compartmentId)
The OCID of the compartment.ListInstancePoolsRequest.Builder
copy(ListInstancePoolsRequest o)
Copy method to populate the builder with values from the given instance.ListInstancePoolsRequest.Builder
displayName(String displayName)
A filter to return only resources that match the given display name exactly.ListInstancePoolsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListInstancePoolsRequest.Builder
lifecycleState(InstancePoolSummary.LifecycleState lifecycleState)
A filter to only return resources that match the given lifecycle state.ListInstancePoolsRequest.Builder
limit(Integer limit)
For list pagination.ListInstancePoolsRequest.Builder
page(String page)
For list pagination.ListInstancePoolsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListInstancePoolsRequest.Builder
sortBy(ListInstancePoolsRequest.SortBy sortBy)
The field to sort by.ListInstancePoolsRequest.Builder
sortOrder(ListInstancePoolsRequest.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$
-
-
-
-
Method Detail
-
compartmentId
public ListInstancePoolsRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
displayName
public ListInstancePoolsRequest.Builder displayName(String displayName)
A filter to return only resources that match the given display name exactly.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
limit
public ListInstancePoolsRequest.Builder limit(Integer limit)
For list pagination.The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.
Example: 50
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListInstancePoolsRequest.Builder page(String page)
For list pagination.The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
sortBy
public ListInstancePoolsRequest.Builder sortBy(ListInstancePoolsRequest.SortBy sortBy)
The field to sort by.You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME 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 ListInstancePoolsRequest.Builder sortOrder(ListInstancePoolsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).The DISPLAYNAME sort order is case sensitive.
- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListInstancePoolsRequest.Builder lifecycleState(InstancePoolSummary.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 ListInstancePoolsRequest.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 ListInstancePoolsRequest.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 ListInstancePoolsRequest.Builder copy(ListInstancePoolsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListInstancePoolsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListInstancePoolsRequest build()
Build the instance of ListInstancePoolsRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListInstancePoolsRequest,Void>
- Returns:
- instance of ListInstancePoolsRequest
-
buildWithoutInvocationCallback
public ListInstancePoolsRequest buildWithoutInvocationCallback()
Build the instance of ListInstancePoolsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListInstancePoolsRequest
-
-