@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public class ApiGatewayClient extends Object implements ApiGateway
Modifier and Type | Class and Description |
---|---|
static class |
ApiGatewayClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ApiGateway.
|
Modifier | Constructor and Description |
---|---|
|
ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ApiGatewayClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ApiGatewayClient(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.
|
|
ApiGatewayClient(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.
|
|
ApiGatewayClient(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 |
ApiGatewayClient(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.
|
|
ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static ApiGatewayClient.Builder |
builder()
Create a builder for this client.
|
ChangeApiCompartmentResponse |
changeApiCompartment(ChangeApiCompartmentRequest request)
Changes the API compartment.
|
ChangeCertificateCompartmentResponse |
changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
Changes the certificate compartment.
|
void |
close() |
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.
|
public static final Service SERVICE
Service instance for ApiGateway.
public ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ApiGatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public ApiGatewayClient(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.
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.public ApiGatewayClient(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.
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.public ApiGatewayClient(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.
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.public ApiGatewayClient(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.
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
)public ApiGatewayClient(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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ApiGatewayClient(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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorprotected ApiGatewayClient(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 ApiGatewayClient.Builder
to get access to all these 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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static ApiGatewayClient.Builder builder()
Create a builder for this client.
public void refreshClient()
ApiGateway
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface ApiGateway
public void setEndpoint(String endpoint)
ApiGateway
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ApiGateway
endpoint
- The endpoint of the service.public String getEndpoint()
ApiGateway
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ApiGateway
public void setRegion(Region region)
ApiGateway
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.
setRegion
in interface ApiGateway
region
- The region of the service.public void setRegion(String regionId)
ApiGateway
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
.
setRegion
in interface ApiGateway
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public ChangeApiCompartmentResponse changeApiCompartment(ChangeApiCompartmentRequest request)
ApiGateway
Changes the API compartment.
changeApiCompartment
in interface ApiGateway
request
- The request object containing the details to sendpublic ChangeCertificateCompartmentResponse changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
ApiGateway
Changes the certificate compartment.
changeCertificateCompartment
in interface ApiGateway
request
- The request object containing the details to sendpublic CreateApiResponse createApi(CreateApiRequest request)
ApiGateway
Creates a new API.
createApi
in interface ApiGateway
request
- The request object containing the details to sendpublic CreateCertificateResponse createCertificate(CreateCertificateRequest request)
ApiGateway
Creates a new Certificate.
createCertificate
in interface ApiGateway
request
- The request object containing the details to sendpublic CreateSdkResponse createSdk(CreateSdkRequest request)
ApiGateway
Creates a new SDK.
createSdk
in interface ApiGateway
request
- The request object containing the details to sendpublic DeleteApiResponse deleteApi(DeleteApiRequest request)
ApiGateway
Deletes the API with the given identifier.
deleteApi
in interface ApiGateway
request
- The request object containing the details to sendpublic DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
ApiGateway
Deletes the certificate with the given identifier.
deleteCertificate
in interface ApiGateway
request
- The request object containing the details to sendpublic DeleteSdkResponse deleteSdk(DeleteSdkRequest request)
ApiGateway
Deletes provided SDK.
deleteSdk
in interface ApiGateway
request
- The request object containing the details to sendpublic GetApiResponse getApi(GetApiRequest request)
ApiGateway
Gets an API by identifier.
getApi
in interface ApiGateway
request
- The request object containing the details to sendpublic GetApiContentResponse getApiContent(GetApiContentRequest request)
ApiGateway
Get the raw API content.
getApiContent
in interface ApiGateway
request
- The request object containing the details to sendpublic GetApiDeploymentSpecificationResponse getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request)
ApiGateway
Gets an API Deployment specification by identifier.
getApiDeploymentSpecification
in interface ApiGateway
request
- The request object containing the details to sendpublic GetApiValidationsResponse getApiValidations(GetApiValidationsRequest request)
ApiGateway
Gets the API validation results.
getApiValidations
in interface ApiGateway
request
- The request object containing the details to sendpublic GetCertificateResponse getCertificate(GetCertificateRequest request)
ApiGateway
Gets a certificate by identifier.
getCertificate
in interface ApiGateway
request
- The request object containing the details to sendpublic GetSdkResponse getSdk(GetSdkRequest request)
ApiGateway
Return object store downloadable URL and metadata.
getSdk
in interface ApiGateway
request
- The request object containing the details to sendpublic ListApisResponse listApis(ListApisRequest request)
ApiGateway
Returns a list of APIs.
listApis
in interface ApiGateway
request
- The request object containing the details to sendpublic ListCertificatesResponse listCertificates(ListCertificatesRequest request)
ApiGateway
Returns a list of certificates.
listCertificates
in interface ApiGateway
request
- The request object containing the details to sendpublic ListSdkLanguageTypesResponse listSdkLanguageTypes(ListSdkLanguageTypesRequest request)
ApiGateway
Lists programming languages in which SDK can be generated.
listSdkLanguageTypes
in interface ApiGateway
request
- The request object containing the details to sendpublic ListSdksResponse listSdks(ListSdksRequest request)
ApiGateway
Returns list of generated SDKs.
listSdks
in interface ApiGateway
request
- The request object containing the details to sendpublic UpdateApiResponse updateApi(UpdateApiRequest request)
ApiGateway
Updates the API with the given identifier.
updateApi
in interface ApiGateway
request
- The request object containing the details to sendpublic UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request)
ApiGateway
Updates a certificate with the given identifier
updateCertificate
in interface ApiGateway
request
- The request object containing the details to sendpublic UpdateSdkResponse updateSdk(UpdateSdkRequest request)
ApiGateway
Updates the SDK with the given identifier.
updateSdk
in interface ApiGateway
request
- The request object containing the details to sendpublic ApiGatewayWaiters getWaiters()
ApiGateway
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ApiGateway
public ApiGatewayPaginators getPaginators()
ApiGateway
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.
getPaginators
in interface ApiGateway
Copyright © 2016–2022. All rights reserved.