public static class ListApisRequest.Builder extends Object implements BmcRequest.Builder<ListApisRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListApisRequest |
build()
Build the instance of ListApisRequest as configured by this builder
|
ListApisRequest |
buildWithoutInvocationCallback()
Build the instance of ListApisRequest as configured by this builder
|
ListApisRequest.Builder |
compartmentId(String compartmentId)
The ocid of the compartment in which to list resources.
|
ListApisRequest.Builder |
copy(ListApisRequest o)
Copy method to populate the builder with values from the given instance.
|
ListApisRequest.Builder |
displayName(String displayName)
A user-friendly name.
|
ListApisRequest.Builder |
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
|
ListApisRequest.Builder |
lifecycleState(ApiSummary.LifecycleState lifecycleState)
A filter to return only resources that match the given lifecycle state.
|
ListApisRequest.Builder |
limit(Integer limit)
The maximum number of items to return.
|
ListApisRequest.Builder |
opcRequestId(String opcRequestId)
The client request id for tracing.
|
ListApisRequest.Builder |
page(String page)
The page token representing the page at which to start retrieving results.
|
ListApisRequest.Builder |
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
|
ListApisRequest.Builder |
sortBy(ListApisRequest.SortBy sortBy)
The field to sort by.
|
ListApisRequest.Builder |
sortOrder(ListApisRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListApisRequest.Builder compartmentId(String compartmentId)
The ocid of the compartment in which to list resources.
compartmentId
- the value to setpublic ListApisRequest.Builder displayName(String displayName)
A user-friendly name. Does not have to be unique, and it’s changeable.
Example: My new resource
displayName
- the value to setpublic ListApisRequest.Builder lifecycleState(ApiSummary.LifecycleState lifecycleState)
A filter to return only resources that match the given lifecycle state.
Example: ACTIVE
lifecycleState
- the value to setpublic ListApisRequest.Builder limit(Integer limit)
The maximum number of items to return.
limit
- the value to setpublic ListApisRequest.Builder page(String page)
The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
page
- the value to setpublic ListApisRequest.Builder sortOrder(ListApisRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’. The default order depends on the sortBy value.
sortOrder
- the value to setpublic ListApisRequest.Builder sortBy(ListApisRequest.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.
sortBy
- the value to setpublic ListApisRequest.Builder opcRequestId(String opcRequestId)
The client request id for tracing.
opcRequestId
- the value to setpublic ListApisRequest.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 ListApisRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListApisRequest.Builder copy(ListApisRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListApisRequest,Void>
o
- other request from which to copy valuespublic ListApisRequest build()
Build the instance of ListApisRequest 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<ListApisRequest,Void>
public ListApisRequest buildWithoutInvocationCallback()
Build the instance of ListApisRequest 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.