Class ListEntitlementsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.osmanagementhub.requests.ListEntitlementsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListEntitlementsRequest,Void>
- Enclosing class:
- ListEntitlementsRequest
public static class ListEntitlementsRequest.Builder extends Object implements BmcRequest.Builder<ListEntitlementsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListEntitlementsRequestbuild()Build the instance of ListEntitlementsRequest as configured by this builderListEntitlementsRequestbuildWithoutInvocationCallback()Build the instance of ListEntitlementsRequest as configured by this builderListEntitlementsRequest.BuildercompartmentId(String compartmentId)The OCID of the compartment.ListEntitlementsRequest.Buildercopy(ListEntitlementsRequest o)Copy method to populate the builder with values from the given instance.ListEntitlementsRequest.Buildercsi(String csi)A filter to return entitlements that match the given customer support identifier (CSI).ListEntitlementsRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListEntitlementsRequest.Builderlimit(Integer limit)For list pagination.ListEntitlementsRequest.BuilderopcRequestId(String opcRequestId)Unique Oracle-assigned identifier for the request.ListEntitlementsRequest.Builderpage(String page)For list pagination.ListEntitlementsRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListEntitlementsRequest.BuildersortBy(ListEntitlementsRequest.SortBy sortBy)The field to sort entitlements by.ListEntitlementsRequest.BuildersortOrder(SortOrder sortOrder)The sort order to use, either ‘ASC’ or ‘DESC’.ListEntitlementsRequest.BuildervendorName(VendorName vendorName)A filter to return only resources that match the given vendor name.-
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 ListEntitlementsRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.This parameter is required and returns only resources contained within the specified compartment.
- Parameters:
compartmentId- the value to set- Returns:
- this builder instance
-
csi
public ListEntitlementsRequest.Builder csi(String csi)
A filter to return entitlements that match the given customer support identifier (CSI).- Parameters:
csi- the value to set- Returns:
- this builder instance
-
vendorName
public ListEntitlementsRequest.Builder vendorName(VendorName vendorName)
A filter to return only resources that match the given vendor name.- Parameters:
vendorName- the value to set- Returns:
- this builder instance
-
limit
public ListEntitlementsRequest.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 ListEntitlementsRequest.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.
Example: 3
- Parameters:
page- the value to set- Returns:
- this builder instance
-
sortOrder
public ListEntitlementsRequest.Builder sortOrder(SortOrder sortOrder)
The sort order to use, either ‘ASC’ or ‘DESC’.- Parameters:
sortOrder- the value to set- Returns:
- this builder instance
-
sortBy
public ListEntitlementsRequest.Builder sortBy(ListEntitlementsRequest.SortBy sortBy)
The field to sort entitlements by.Only one sort order may be provided.
- Parameters:
sortBy- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListEntitlementsRequest.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.
- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListEntitlementsRequest.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 ListEntitlementsRequest.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 ListEntitlementsRequest.Builder copy(ListEntitlementsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListEntitlementsRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListEntitlementsRequest build()
Build the instance of ListEntitlementsRequest 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:
buildin interfaceBmcRequest.Builder<ListEntitlementsRequest,Void>- Returns:
- instance of ListEntitlementsRequest
-
buildWithoutInvocationCallback
public ListEntitlementsRequest buildWithoutInvocationCallback()
Build the instance of ListEntitlementsRequest 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 ListEntitlementsRequest
-
-