Class LimitsIncreaseClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.limitsincrease.LimitsIncreaseClient
-
- All Implemented Interfaces:
LimitsIncrease,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20251101") public class LimitsIncreaseClient extends BaseSyncClient implements LimitsIncrease
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLimitsIncreaseClient.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 LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LimitsIncreaseClient.Builderbuilder()Create a builder for this client.CancelLimitsIncreaseItemRequestResponsecancelLimitsIncreaseItemRequest(CancelLimitsIncreaseItemRequestRequest request)Withdraws the specified item from the limit increase request.CancelLimitsIncreaseRequestResponsecancelLimitsIncreaseRequest(CancelLimitsIncreaseRequestRequest request)Withdraws the specified limit increase request.voidclose()CreateLimitsIncreaseRequestResponsecreateLimitsIncreaseRequest(CreateLimitsIncreaseRequestRequest request)Creates a limit increase request in the specified compartment.DeleteLimitsIncreaseRequestResponsedeleteLimitsIncreaseRequest(DeleteLimitsIncreaseRequestRequest request)Deletes the specified limit increase request.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetLimitsIncreaseItemRequestResponsegetLimitsIncreaseItemRequest(GetLimitsIncreaseItemRequestRequest request)Gets the specified item from the limit increase request.GetLimitsIncreaseRequestResponsegetLimitsIncreaseRequest(GetLimitsIncreaseRequestRequest request)Gets the specified limit increase request.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.LimitsIncreasePaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(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.LimitsIncreaseWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListLimitsIncreaseItemRequestsResponselistLimitsIncreaseItemRequests(ListLimitsIncreaseItemRequestsRequest request)Lists items in the specified limit increase request.ListLimitsIncreaseQuestionsResponselistLimitsIncreaseQuestions(ListLimitsIncreaseQuestionsRequest request)Gets the fields for the specified service and limit name.ListLimitsIncreaseRequestsResponselistLimitsIncreaseRequests(ListLimitsIncreaseRequestsRequest request)Lists limit increase requests in the specified compartment.PatchLimitsIncreaseRequestResponsepatchLimitsIncreaseRequest(PatchLimitsIncreaseRequestRequest request)Adds one or more comments to the specified limit increase request.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateLimitsIncreaseRequestResponseupdateLimitsIncreaseRequest(UpdateLimitsIncreaseRequestRequest request)Updates the limit increase request.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
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.LimitsIncrease
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(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 (seeLimitsIncreaseClient.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)
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(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 (seeLimitsIncreaseClient.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
-
LimitsIncreaseClient
@Deprecated public LimitsIncreaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeLimitsIncreaseClient.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.signingStrategyRequestSignerFactoriesexecutorService-LimitsIncreaseClient.Builder.executorService
-
-
Method Detail
-
builder
public static LimitsIncreaseClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:LimitsIncreaseSets 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 interfaceLimitsIncrease- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:LimitsIncreaseSets 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 interfaceLimitsIncrease- Parameters:
regionId- The public region ID.
-
cancelLimitsIncreaseItemRequest
public CancelLimitsIncreaseItemRequestResponse cancelLimitsIncreaseItemRequest(CancelLimitsIncreaseItemRequestRequest request)
Description copied from interface:LimitsIncreaseWithdraws the specified item from the limit increase request.For more information, see Withdrawing an Item from a Limit Increase Request.
- Specified by:
cancelLimitsIncreaseItemRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelLimitsIncreaseRequest
public CancelLimitsIncreaseRequestResponse cancelLimitsIncreaseRequest(CancelLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseWithdraws the specified limit increase request.For more information, see Withdrawing a Limit Increase Request.
- Specified by:
cancelLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createLimitsIncreaseRequest
public CreateLimitsIncreaseRequestResponse createLimitsIncreaseRequest(CreateLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseCreates a limit increase request in the specified compartment.For more information, see Creating a Limit Increase Request.
- Specified by:
createLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteLimitsIncreaseRequest
public DeleteLimitsIncreaseRequestResponse deleteLimitsIncreaseRequest(DeleteLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseDeletes the specified limit increase request.For more information, see Deleting a Limit Increase Request.
- Specified by:
deleteLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLimitsIncreaseItemRequest
public GetLimitsIncreaseItemRequestResponse getLimitsIncreaseItemRequest(GetLimitsIncreaseItemRequestRequest request)
Description copied from interface:LimitsIncreaseGets the specified item from the limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
getLimitsIncreaseItemRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getLimitsIncreaseRequest
public GetLimitsIncreaseRequestResponse getLimitsIncreaseRequest(GetLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseGets the specified limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
getLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLimitsIncreaseItemRequests
public ListLimitsIncreaseItemRequestsResponse listLimitsIncreaseItemRequests(ListLimitsIncreaseItemRequestsRequest request)
Description copied from interface:LimitsIncreaseLists items in the specified limit increase request.For more information, see Getting Details for a Limit Increase Request.
- Specified by:
listLimitsIncreaseItemRequestsin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLimitsIncreaseQuestions
public ListLimitsIncreaseQuestionsResponse listLimitsIncreaseQuestions(ListLimitsIncreaseQuestionsRequest request)
Description copied from interface:LimitsIncreaseGets 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 interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listLimitsIncreaseRequests
public ListLimitsIncreaseRequestsResponse listLimitsIncreaseRequests(ListLimitsIncreaseRequestsRequest request)
Description copied from interface:LimitsIncreaseLists limit increase requests in the specified compartment.For more information, see Listing Limit Increase Requests.
- Specified by:
listLimitsIncreaseRequestsin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchLimitsIncreaseRequest
public PatchLimitsIncreaseRequestResponse patchLimitsIncreaseRequest(PatchLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseAdds one or more comments to the specified limit increase request.For more information, see Adding Comments to a Limit Increase Request.
- Specified by:
patchLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateLimitsIncreaseRequest
public UpdateLimitsIncreaseRequestResponse updateLimitsIncreaseRequest(UpdateLimitsIncreaseRequestRequest request)
Description copied from interface:LimitsIncreaseUpdates the limit increase request.For more information, see Updating a Limit Increase Request.
- Specified by:
updateLimitsIncreaseRequestin interfaceLimitsIncrease- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public LimitsIncreaseWaiters getWaiters()
Description copied from interface:LimitsIncreaseGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceLimitsIncrease- Returns:
- The service waiters.
-
getPaginators
public LimitsIncreasePaginators getPaginators()
Description copied from interface:LimitsIncreaseGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceLimitsIncrease- Returns:
- The service paginators.
-
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()
-
-