QuotasClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.limits.QuotasClient

All Implemented Interfaces:: Quotas, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181025")
public class QuotasClient
extends Object
implements Quotas

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QuotasClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`QuotasClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for Quotas.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Quotas.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddQuotaLockResponse`	`addQuotaLock(AddQuotaLockRequest request)` Adds a lock to a resource.
`static QuotasClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`CreateQuotaResponse`	`createQuota(CreateQuotaRequest request)` Creates a new quota with the details supplied.
`DeleteQuotaResponse`	`deleteQuota(DeleteQuotaRequest request)` Deletes the quota corresponding to the given OCID.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`QuotasPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetQuotaResponse`	`getQuota(GetQuotaRequest request)` Gets the quota for the OCID specified.
`QuotasWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListQuotasResponse`	`listQuotas(ListQuotasRequest request)` Lists all quotas on resources from the given compartment.
`RemoveQuotaLockResponse`	`removeQuotaLock(RemoveQuotaLockRequest request)` Remove a lock from a resource.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateQuotaResponse`	`updateQuota(UpdateQuotaRequest request)` Updates the quota corresponding to given OCID with the details supplied.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Quotas.
- Constructor Detail
  - QuotasClient
```
public QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - QuotasClient
```
public QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - QuotasClient
```
public QuotasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - QuotasClient
```
public QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - QuotasClient
```
public QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - QuotasClient
```
public QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - QuotasClient
```
public QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - QuotasClient
```
public QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint,
                    ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - QuotasClient
```
protected QuotasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService,
                       RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the QuotasClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static QuotasClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Quotas
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Quotas
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Quotas
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Quotas
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Quotas
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface Quotas
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Quotas
    
    Sets 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 call setEndpoint.
    
    Specified by:
    
    setRegion in interface Quotas
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - addQuotaLock
```
public AddQuotaLockResponse addQuotaLock(AddQuotaLockRequest request)
```
    Description copied from interface: Quotas
    
    Adds a lock to a resource.
    
    Specified by:
    
    addQuotaLock in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createQuota
```
public CreateQuotaResponse createQuota(CreateQuotaRequest request)
```
    Description copied from interface: Quotas
    
    Creates a new quota with the details supplied.
    
    Specified by:
    
    createQuota in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteQuota
```
public DeleteQuotaResponse deleteQuota(DeleteQuotaRequest request)
```
    Description copied from interface: Quotas
    
    Deletes the quota corresponding to the given OCID.
    
    Specified by:
    
    deleteQuota in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getQuota
```
public GetQuotaResponse getQuota(GetQuotaRequest request)
```
    Description copied from interface: Quotas
    
    Gets the quota for the OCID specified.
    
    Specified by:
    
    getQuota in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listQuotas
```
public ListQuotasResponse listQuotas(ListQuotasRequest request)
```
    Description copied from interface: Quotas
    
    Lists all quotas on resources from the given compartment.
    
    Specified by:
    
    listQuotas in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeQuotaLock
```
public RemoveQuotaLockResponse removeQuotaLock(RemoveQuotaLockRequest request)
```
    Description copied from interface: Quotas
    
    Remove a lock from a resource.
    
    Specified by:
    
    removeQuotaLock in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateQuota
```
public UpdateQuotaResponse updateQuota(UpdateQuotaRequest request)
```
    Description copied from interface: Quotas
    
    Updates the quota corresponding to given OCID with the details supplied.
    
    Specified by:
    
    updateQuota in interface Quotas
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public QuotasWaiters getWaiters()
```
    Description copied from interface: Quotas
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface Quotas
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public QuotasPaginators getPaginators()
```
    Description copied from interface: Quotas
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface Quotas
    
    Returns:
    
    The service paginators.

Class QuotasClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

QuotasClient

QuotasClient

QuotasClient

QuotasClient

QuotasClient

QuotasClient

QuotasClient

QuotasClient

QuotasClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

addQuotaLock

createQuota

deleteQuota

getQuota

listQuotas

removeQuotaLock

updateQuota

getWaiters

getPaginators