ApiGateway (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ApiGatewayClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface ApiGateway
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 and Description
`ChangeApiCompartmentResponse`	`changeApiCompartment(ChangeApiCompartmentRequest request)` Changes the API compartment.
`ChangeCertificateCompartmentResponse`	`changeCertificateCompartment(ChangeCertificateCompartmentRequest request)` Changes the certificate compartment.
`CreateApiResponse`	`createApi(CreateApiRequest request)` Creates a new API.
`CreateCertificateResponse`	`createCertificate(CreateCertificateRequest request)` Creates a new Certificate.
`CreateSdkResponse`	`createSdk(CreateSdkRequest request)` Creates a new SDK.
`DeleteApiResponse`	`deleteApi(DeleteApiRequest request)` Deletes the API with the given identifier.
`DeleteCertificateResponse`	`deleteCertificate(DeleteCertificateRequest request)` Deletes the certificate with the given identifier.
`DeleteSdkResponse`	`deleteSdk(DeleteSdkRequest request)` Deletes provided SDK.
`GetApiResponse`	`getApi(GetApiRequest request)` Gets an API by identifier.
`GetApiContentResponse`	`getApiContent(GetApiContentRequest request)` Get the raw API content.
`GetApiDeploymentSpecificationResponse`	`getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request)` Gets an API Deployment specification by identifier.
`GetApiValidationsResponse`	`getApiValidations(GetApiValidationsRequest request)` Gets the API validation results.
`GetCertificateResponse`	`getCertificate(GetCertificateRequest request)` Gets a certificate by identifier.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`ApiGatewayPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetSdkResponse`	`getSdk(GetSdkRequest request)` Return object store downloadable URL and metadata.
`ApiGatewayWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListApisResponse`	`listApis(ListApisRequest request)` Returns a list of APIs.
`ListCertificatesResponse`	`listCertificates(ListCertificatesRequest request)` Returns a list of certificates.
`ListSdkLanguageTypesResponse`	`listSdkLanguageTypes(ListSdkLanguageTypesRequest request)` Lists programming languages in which SDK can be generated.
`ListSdksResponse`	`listSdks(ListSdksRequest request)` Returns list of generated SDKs.
`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’).
`UpdateApiResponse`	`updateApi(UpdateApiRequest request)` Updates the API with the given identifier.
`UpdateCertificateResponse`	`updateCertificate(UpdateCertificateRequest request)` Updates a certificate with the given identifier
`UpdateSdkResponse`	`updateSdk(UpdateSdkRequest request)` Updates the SDK 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
  - changeApiCompartment
```
ChangeApiCompartmentResponse changeApiCompartment(ChangeApiCompartmentRequest request)
```
    Changes the API 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 here to see how to use ChangeApiCompartment API.
  - changeCertificateCompartment
```
ChangeCertificateCompartmentResponse changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
```
    Changes the certificate 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 here to see how to use ChangeCertificateCompartment API.
  - createApi
```
CreateApiResponse createApi(CreateApiRequest request)
```
    Creates a new API.
    
    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 here to see how to use CreateApi API.
  - createCertificate
```
CreateCertificateResponse createCertificate(CreateCertificateRequest request)
```
    Creates a new Certificate.
    
    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 here to see how to use CreateCertificate API.
  - createSdk
```
CreateSdkResponse createSdk(CreateSdkRequest request)
```
    Creates a new SDK.
    
    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 here to see how to use CreateSdk API.
  - deleteApi
```
DeleteApiResponse deleteApi(DeleteApiRequest request)
```
    Deletes the API 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 here to see how to use DeleteApi API.
  - deleteCertificate
```
DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
```
    Deletes the certificate 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 here to see how to use DeleteCertificate API.
  - deleteSdk
```
DeleteSdkResponse deleteSdk(DeleteSdkRequest request)
```
    Deletes provided SDK.
    
    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 here to see how to use DeleteSdk API.
  - getApi
```
GetApiResponse getApi(GetApiRequest request)
```
    Gets an API 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 here to see how to use GetApi API.
  - getApiContent
```
GetApiContentResponse getApiContent(GetApiContentRequest request)
```
    Get the raw API content.
    
    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 here to see how to use GetApiContent API.
  - getApiDeploymentSpecification
```
GetApiDeploymentSpecificationResponse getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request)
```
    Gets an API Deployment specification 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 here to see how to use GetApiDeploymentSpecification API.
  - getApiValidations
```
GetApiValidationsResponse getApiValidations(GetApiValidationsRequest request)
```
    Gets the API validation results.
    
    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 here to see how to use GetApiValidations API.
  - getCertificate
```
GetCertificateResponse getCertificate(GetCertificateRequest request)
```
    Gets a certificate 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 here to see how to use GetCertificate API.
  - getSdk
```
GetSdkResponse getSdk(GetSdkRequest request)
```
    Return object store downloadable URL and metadata.
    
    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 here to see how to use GetSdk API.
  - listApis
```
ListApisResponse listApis(ListApisRequest request)
```
    Returns a list of APIs.
    
    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 here to see how to use ListApis API.
  - listCertificates
```
ListCertificatesResponse listCertificates(ListCertificatesRequest request)
```
    Returns a list of certificates.
    
    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 here to see how to use ListCertificates API.
  - listSdkLanguageTypes
```
ListSdkLanguageTypesResponse listSdkLanguageTypes(ListSdkLanguageTypesRequest request)
```
    Lists programming languages in which SDK can be generated.
    
    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 here to see how to use ListSdkLanguageTypes API.
  - listSdks
```
ListSdksResponse listSdks(ListSdksRequest request)
```
    Returns list of generated SDKs.
    
    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 here to see how to use ListSdks API.
  - updateApi
```
UpdateApiResponse updateApi(UpdateApiRequest request)
```
    Updates the API 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 here to see how to use UpdateApi API.
  - updateCertificate
```
UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request)
```
    Updates a certificate 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 here to see how to use UpdateCertificate API.
  - updateSdk
```
UpdateSdkResponse updateSdk(UpdateSdkRequest request)
```
    Updates the SDK 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 here to see how to use UpdateSdk API.
  - getWaiters
```
ApiGatewayWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
ApiGatewayPaginators 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 ApiGateway

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeApiCompartment

changeCertificateCompartment

createApi

createCertificate

createSdk

deleteApi

deleteCertificate

deleteSdk

getApi

getApiContent

getApiDeploymentSpecification

getApiValidations

getCertificate

getSdk

listApis

listCertificates

listSdkLanguageTypes

listSdks

updateApi

updateCertificate

updateSdk

getWaiters

getPaginators