All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

UsagePlansClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface UsagePlans
extends AutoCloseable
```
API for the API Gateway service.
Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ChangeUsagePlanCompartmentResponse`	`changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request)`	Changes the usage plan compartment.
`CreateUsagePlanResponse`	`createUsagePlan(CreateUsagePlanRequest request)`	Creates a new usage plan.
`DeleteUsagePlanResponse`	`deleteUsagePlan(DeleteUsagePlanRequest request)`	Deletes the usage plan with the given identifier.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`UsagePlansPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetUsagePlanResponse`	`getUsagePlan(GetUsagePlanRequest request)`	Gets a usage plan by identifier.
`UsagePlansWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListUsagePlansResponse`	`listUsagePlans(ListUsagePlansRequest request)`	Returns a list of usage plans.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`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’).
`UpdateUsagePlanResponse`	`updateUsagePlan(UpdateUsagePlanRequest request)`	Updates the usage plan with the given identifier.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch.
    Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not.
    Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - changeUsagePlanCompartment
```
ChangeUsagePlanCompartmentResponse changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request)
```
    Changes the usage plan compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/ChangeUsagePlanCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeUsagePlanCompartment API.
  - createUsagePlan
```
CreateUsagePlanResponse createUsagePlan(CreateUsagePlanRequest request)
```
    Creates a new usage plan.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/CreateUsagePlanExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateUsagePlan API.
  - deleteUsagePlan
```
DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest request)
```
    Deletes the usage plan with the given identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/DeleteUsagePlanExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUsagePlan API.
  - getUsagePlan
```
GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest request)
```
    Gets a usage plan by identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/GetUsagePlanExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUsagePlan API.
  - listUsagePlans
```
ListUsagePlansResponse listUsagePlans(ListUsagePlansRequest request)
```
    Returns a list of usage plans.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/ListUsagePlansExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUsagePlans API.
  - updateUsagePlan
```
UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest request)
```
    Updates the usage plan with the given identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/apigateway/UpdateUsagePlanExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateUsagePlan API.
  - getWaiters
```
UsagePlansWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
UsagePlansPaginators getPaginators()
```
    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.
    
    Returns:
    
    The service paginators.

Interface UsagePlans

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeUsagePlanCompartment

createUsagePlan

deleteUsagePlan

getUsagePlan

listUsagePlans

updateUsagePlan

getWaiters

getPaginators