@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public class ApiGatewayAsyncClient extends Object implements ApiGatewayAsync
Async client implementation for ApiGateway service.
There are two ways to use async client:
InputStream
, like
getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else,
because the stream will be closed right after the AsyncHandler is invoked. Modifier and Type | Class and Description |
---|---|
static class |
ApiGatewayAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ApiGateway.
|
Constructor and Description |
---|
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ApiGatewayAsyncClient(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.
|
ApiGatewayAsyncClient(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.
|
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for ApiGateway.
public ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(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 ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, 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.
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
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static ApiGatewayAsyncClient.Builder builder()
Create a builder for this client.
public void refreshClient()
ApiGatewayAsync
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface ApiGatewayAsync
public void setEndpoint(String endpoint)
ApiGatewayAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ApiGatewayAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
ApiGatewayAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ApiGatewayAsync
public void setRegion(Region region)
ApiGatewayAsync
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 ApiGatewayAsync
region
- The region of the service.public void setRegion(String regionId)
ApiGatewayAsync
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 ApiGatewayAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<ChangeApiCompartmentResponse> changeApiCompartment(ChangeApiCompartmentRequest request, AsyncHandler<ChangeApiCompartmentRequest,ChangeApiCompartmentResponse> handler)
ApiGatewayAsync
Changes the API compartment.
changeApiCompartment
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeCertificateCompartmentResponse> changeCertificateCompartment(ChangeCertificateCompartmentRequest request, AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler)
ApiGatewayAsync
Changes the certificate compartment.
changeCertificateCompartment
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateApiResponse> createApi(CreateApiRequest request, AsyncHandler<CreateApiRequest,CreateApiResponse> handler)
ApiGatewayAsync
Creates a new API.
createApi
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)
ApiGatewayAsync
Creates a new Certificate.
createCertificate
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSdkResponse> createSdk(CreateSdkRequest request, AsyncHandler<CreateSdkRequest,CreateSdkResponse> handler)
ApiGatewayAsync
Creates a new SDK.
createSdk
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteApiResponse> deleteApi(DeleteApiRequest request, AsyncHandler<DeleteApiRequest,DeleteApiResponse> handler)
ApiGatewayAsync
Deletes the API with the given identifier.
deleteApi
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResponse> handler)
ApiGatewayAsync
Deletes the certificate with the given identifier.
deleteCertificate
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSdkResponse> deleteSdk(DeleteSdkRequest request, AsyncHandler<DeleteSdkRequest,DeleteSdkResponse> handler)
ApiGatewayAsync
Deletes provided SDK.
deleteSdk
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetApiResponse> getApi(GetApiRequest request, AsyncHandler<GetApiRequest,GetApiResponse> handler)
ApiGatewayAsync
Gets an API by identifier.
getApi
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetApiContentResponse> getApiContent(GetApiContentRequest request, AsyncHandler<GetApiContentRequest,GetApiContentResponse> handler)
ApiGatewayAsync
Get the raw API content.
getApiContent
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetApiDeploymentSpecificationResponse> getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request, AsyncHandler<GetApiDeploymentSpecificationRequest,GetApiDeploymentSpecificationResponse> handler)
ApiGatewayAsync
Gets an API Deployment specification by identifier.
getApiDeploymentSpecification
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetApiValidationsResponse> getApiValidations(GetApiValidationsRequest request, AsyncHandler<GetApiValidationsRequest,GetApiValidationsResponse> handler)
ApiGatewayAsync
Gets the API validation results.
getApiValidations
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetCertificateResponse> getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)
ApiGatewayAsync
Gets a certificate by identifier.
getCertificate
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetSdkResponse> getSdk(GetSdkRequest request, AsyncHandler<GetSdkRequest,GetSdkResponse> handler)
ApiGatewayAsync
Return object store downloadable URL and metadata.
getSdk
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListApisResponse> listApis(ListApisRequest request, AsyncHandler<ListApisRequest,ListApisResponse> handler)
ApiGatewayAsync
Returns a list of APIs.
listApis
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)
ApiGatewayAsync
Returns a list of certificates.
listCertificates
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSdkLanguageTypesResponse> listSdkLanguageTypes(ListSdkLanguageTypesRequest request, AsyncHandler<ListSdkLanguageTypesRequest,ListSdkLanguageTypesResponse> handler)
ApiGatewayAsync
Lists programming languages in which SDK can be generated.
listSdkLanguageTypes
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSdksResponse> listSdks(ListSdksRequest request, AsyncHandler<ListSdksRequest,ListSdksResponse> handler)
ApiGatewayAsync
Returns list of generated SDKs.
listSdks
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateApiResponse> updateApi(UpdateApiRequest request, AsyncHandler<UpdateApiRequest,UpdateApiResponse> handler)
ApiGatewayAsync
Updates the API with the given identifier.
updateApi
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler)
ApiGatewayAsync
Updates a certificate with the given identifier
updateCertificate
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateSdkResponse> updateSdk(UpdateSdkRequest request, AsyncHandler<UpdateSdkRequest,UpdateSdkResponse> handler)
ApiGatewayAsync
Updates the SDK with the given identifier.
updateSdk
in interface ApiGatewayAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.