Class ListHsmPartitionsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.keymanagement.requests.ListHsmPartitionsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListHsmPartitionsRequest,Void>
- Enclosing class:
- ListHsmPartitionsRequest
public static class ListHsmPartitionsRequest.Builder extends Object implements BmcRequest.Builder<ListHsmPartitionsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListHsmPartitionsRequestbuild()Build the instance of ListHsmPartitionsRequest as configured by this builderListHsmPartitionsRequestbuildWithoutInvocationCallback()Build the instance of ListHsmPartitionsRequest as configured by this builderListHsmPartitionsRequest.Buildercopy(ListHsmPartitionsRequest o)Copy method to populate the builder with values from the given instance.ListHsmPartitionsRequest.BuilderhsmClusterId(String hsmClusterId)The OCID of the HSM Cluster.ListHsmPartitionsRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListHsmPartitionsRequest.BuilderlifecycleState(HsmPartition.LifecycleState lifecycleState)A filter that returns only resources that match the specified lifecycle state.ListHsmPartitionsRequest.Builderlimit(Integer limit)The maximum number of items to return in a paginated “List” call.ListHsmPartitionsRequest.BuilderopcRequestId(String opcRequestId)Unique identifier for the request.ListHsmPartitionsRequest.Builderpage(String page)The value of the opc-next-page response header from the previous “List” call.ListHsmPartitionsRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListHsmPartitionsRequest.BuildersortBy(ListHsmPartitionsRequest.SortBy sortBy)The field to sort by.ListHsmPartitionsRequest.BuildersortOrder(ListHsmPartitionsRequest.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
-
hsmClusterId
public ListHsmPartitionsRequest.Builder hsmClusterId(String hsmClusterId)
The OCID of the HSM Cluster.This is a unique identifier assigned to each hsmCluster.
- Parameters:
hsmClusterId- the value to set- Returns:
- this builder instance
-
limit
public ListHsmPartitionsRequest.Builder limit(Integer limit)
The maximum number of items to return in a paginated “List” call.- Parameters:
limit- the value to set- Returns:
- this builder instance
-
page
public ListHsmPartitionsRequest.Builder page(String page)
The value of the opc-next-page response header from the previous “List” call.- Parameters:
page- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListHsmPartitionsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
sortBy
public ListHsmPartitionsRequest.Builder sortBy(ListHsmPartitionsRequest.SortBy sortBy)
The field to sort by.You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.
- Parameters:
sortBy- the value to set- Returns:
- this builder instance
-
sortOrder
public ListHsmPartitionsRequest.Builder sortOrder(ListHsmPartitionsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListHsmPartitionsRequest.Builder lifecycleState(HsmPartition.LifecycleState lifecycleState)
A filter that returns only resources that match the specified lifecycle state.The state value is case-insensitive.
- Parameters:
lifecycleState- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListHsmPartitionsRequest.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 ListHsmPartitionsRequest.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 ListHsmPartitionsRequest.Builder copy(ListHsmPartitionsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListHsmPartitionsRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListHsmPartitionsRequest build()
Build the instance of ListHsmPartitionsRequest 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<ListHsmPartitionsRequest,Void>- Returns:
- instance of ListHsmPartitionsRequest
-
buildWithoutInvocationCallback
public ListHsmPartitionsRequest buildWithoutInvocationCallback()
Build the instance of ListHsmPartitionsRequest 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 ListHsmPartitionsRequest
-
-