Class LimitsIncreaseAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.limitsincrease.LimitsIncreaseAsyncClient
-
- All Implemented Interfaces:
LimitsIncreaseAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20251101") public class LimitsIncreaseAsyncClient extends BaseAsyncClient implements LimitsIncreaseAsyncAsync client implementation for LimitsIncrease service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLimitsIncreaseAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for LimitsIncrease.
-
Constructor Summary
Constructors Constructor Description LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.limitsincrease.LimitsIncreaseAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
LimitsIncreaseAsyncClient
@Deprecated public LimitsIncreaseAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static LimitsIncreaseAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:LimitsIncreaseAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceLimitsIncreaseAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:LimitsIncreaseAsyncSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceLimitsIncreaseAsync- Parameters:
regionId- The public region ID.
-
cancelLimitsIncreaseItemRequest
public Future<CancelLimitsIncreaseItemRequestResponse> cancelLimitsIncreaseItemRequest(CancelLimitsIncreaseItemRequestRequest request, AsyncHandler<CancelLimitsIncreaseItemRequestRequest,CancelLimitsIncreaseItemRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncWithdraws the specified item from the limit increase request.For more information, see Withdrawing an Item from a Limit Increase Request.
- Specified by:
cancelLimitsIncreaseItemRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
cancelLimitsIncreaseRequest
public Future<CancelLimitsIncreaseRequestResponse> cancelLimitsIncreaseRequest(CancelLimitsIncreaseRequestRequest request, AsyncHandler<CancelLimitsIncreaseRequestRequest,CancelLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncWithdraws the specified limit increase request.For more information, see Withdrawing a Limit Increase Request.
- Specified by:
cancelLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createLimitsIncreaseRequest
public Future<CreateLimitsIncreaseRequestResponse> createLimitsIncreaseRequest(CreateLimitsIncreaseRequestRequest request, AsyncHandler<CreateLimitsIncreaseRequestRequest,CreateLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncCreates a limit increase request in the specified compartment.For more information, see Creating a Limit Increase Request.
- Specified by:
createLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteLimitsIncreaseRequest
public Future<DeleteLimitsIncreaseRequestResponse> deleteLimitsIncreaseRequest(DeleteLimitsIncreaseRequestRequest request, AsyncHandler<DeleteLimitsIncreaseRequestRequest,DeleteLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncDeletes the specified limit increase request.For more information, see Deleting a Limit Increase Request.
- Specified by:
deleteLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getLimitsIncreaseItemRequest
public Future<GetLimitsIncreaseItemRequestResponse> getLimitsIncreaseItemRequest(GetLimitsIncreaseItemRequestRequest request, AsyncHandler<GetLimitsIncreaseItemRequestRequest,GetLimitsIncreaseItemRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncGets the specified item from the limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
getLimitsIncreaseItemRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getLimitsIncreaseRequest
public Future<GetLimitsIncreaseRequestResponse> getLimitsIncreaseRequest(GetLimitsIncreaseRequestRequest request, AsyncHandler<GetLimitsIncreaseRequestRequest,GetLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncGets the specified limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
getLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listLimitsIncreaseItemRequests
public Future<ListLimitsIncreaseItemRequestsResponse> listLimitsIncreaseItemRequests(ListLimitsIncreaseItemRequestsRequest request, AsyncHandler<ListLimitsIncreaseItemRequestsRequest,ListLimitsIncreaseItemRequestsResponse> handler)
Description copied from interface:LimitsIncreaseAsyncLists items in the specified limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
listLimitsIncreaseItemRequestsin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listLimitsIncreaseQuestions
public Future<ListLimitsIncreaseQuestionsResponse> listLimitsIncreaseQuestions(ListLimitsIncreaseQuestionsRequest request, AsyncHandler<ListLimitsIncreaseQuestionsRequest,ListLimitsIncreaseQuestionsResponse> handler)
Description copied from interface:LimitsIncreaseAsyncGets the fields for the specified service and limit name.Service name is required if limit name is provided. If limit name is not provided, returns all questions for the specified service. If service name is not provided, returns all available questions. For more information, see Creating a Limit Increase Request.
- Specified by:
listLimitsIncreaseQuestionsin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listLimitsIncreaseRequests
public Future<ListLimitsIncreaseRequestsResponse> listLimitsIncreaseRequests(ListLimitsIncreaseRequestsRequest request, AsyncHandler<ListLimitsIncreaseRequestsRequest,ListLimitsIncreaseRequestsResponse> handler)
Description copied from interface:LimitsIncreaseAsyncLists limit increase requests in the specified compartment.For more information, see Listing Limit Increase Requests.
- Specified by:
listLimitsIncreaseRequestsin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
patchLimitsIncreaseRequest
public Future<PatchLimitsIncreaseRequestResponse> patchLimitsIncreaseRequest(PatchLimitsIncreaseRequestRequest request, AsyncHandler<PatchLimitsIncreaseRequestRequest,PatchLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncAdds one or more comments to the specified limit increase request.For more information, see Adding Comments to a Limit Increase Request.
- Specified by:
patchLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateLimitsIncreaseRequest
public Future<UpdateLimitsIncreaseRequestResponse> updateLimitsIncreaseRequest(UpdateLimitsIncreaseRequestRequest request, AsyncHandler<UpdateLimitsIncreaseRequestRequest,UpdateLimitsIncreaseRequestResponse> handler)
Description copied from interface:LimitsIncreaseAsyncUpdates the limit increase request.For more information, see Updating a Limit Increase Request.
- Specified by:
updateLimitsIncreaseRequestin interfaceLimitsIncreaseAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-