com.oracle.bmc.apigateway

Class ApiGatewayAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.apigateway.ApiGatewayAsyncClient

All Implemented Interfaces:

ApiGatewayAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public class ApiGatewayAsyncClient
extends BaseAsyncClient
implements ApiGatewayAsync

Async client implementation for ApiGateway service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an 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.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiGatewayAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for ApiGateway.

Constructor Summary

Constructors

Constructor and Description
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static ApiGatewayAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeApiCompartmentResponse>	changeApiCompartment(ChangeApiCompartmentRequest request, AsyncHandler<ChangeApiCompartmentRequest,ChangeApiCompartmentResponse> handler) Changes the API compartment.
Future<ChangeCertificateCompartmentResponse>	changeCertificateCompartment(ChangeCertificateCompartmentRequest request, AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler) Changes the certificate compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateApiResponse>	createApi(CreateApiRequest request, AsyncHandler<CreateApiRequest,CreateApiResponse> handler) Creates a new API.
Future<CreateCertificateResponse>	createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler) Creates a new Certificate.
Future<CreateSdkResponse>	createSdk(CreateSdkRequest request, AsyncHandler<CreateSdkRequest,CreateSdkResponse> handler) Creates a new SDK.
Future<DeleteApiResponse>	deleteApi(DeleteApiRequest request, AsyncHandler<DeleteApiRequest,DeleteApiResponse> handler) Deletes the API with the given identifier.
Future<DeleteCertificateResponse>	deleteCertificate(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResponse> handler) Deletes the certificate with the given identifier.
Future<DeleteSdkResponse>	deleteSdk(DeleteSdkRequest request, AsyncHandler<DeleteSdkRequest,DeleteSdkResponse> handler) Deletes provided SDK.
Future<GetApiResponse>	getApi(GetApiRequest request, AsyncHandler<GetApiRequest,GetApiResponse> handler) Gets an API by identifier.
Future<GetApiContentResponse>	getApiContent(GetApiContentRequest request, AsyncHandler<GetApiContentRequest,GetApiContentResponse> handler) Get the raw API content.
Future<GetApiDeploymentSpecificationResponse>	getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request, AsyncHandler<GetApiDeploymentSpecificationRequest,GetApiDeploymentSpecificationResponse> handler) Gets an API Deployment specification by identifier.
Future<GetApiValidationsResponse>	getApiValidations(GetApiValidationsRequest request, AsyncHandler<GetApiValidationsRequest,GetApiValidationsResponse> handler) Gets the API validation results.
Future<GetCertificateResponse>	getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler) Gets a certificate by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetSdkResponse>	getSdk(GetSdkRequest request, AsyncHandler<GetSdkRequest,GetSdkResponse> handler) Return object store downloadable URL and metadata.
Future<ListApisResponse>	listApis(ListApisRequest request, AsyncHandler<ListApisRequest,ListApisResponse> handler) Returns a list of APIs.
Future<ListCertificatesResponse>	listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler) Returns a list of certificates.
Future<ListSdkLanguageTypesResponse>	listSdkLanguageTypes(ListSdkLanguageTypesRequest request, AsyncHandler<ListSdkLanguageTypesRequest,ListSdkLanguageTypesResponse> handler) Lists programming languages in which SDK can be generated.
Future<ListSdksResponse>	listSdks(ListSdksRequest request, AsyncHandler<ListSdksRequest,ListSdksResponse> handler) Returns list of generated SDKs.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
Future<UpdateApiResponse>	updateApi(UpdateApiRequest request, AsyncHandler<UpdateApiRequest,UpdateApiResponse> handler) Updates the API with the given identifier.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateCertificateResponse>	updateCertificate(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler) Updates a certificate with the given identifier
Future<UpdateSdkResponse>	updateSdk(UpdateSdkRequest request, AsyncHandler<UpdateSdkRequest,UpdateSdkResponse> handler) Updates the SDK with the given identifier.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.apigateway.ApiGatewayAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApiGateway.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ApiGatewayAsyncClient

@Deprecated
public ApiGatewayAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ApiGatewayAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static ApiGatewayAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface ApiGatewayAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface ApiGatewayAsync

Parameters:

regionId - The public region ID.

changeApiCompartment

public Future<ChangeApiCompartmentResponse> changeApiCompartment(ChangeApiCompartmentRequest request,
                                                                 AsyncHandler<ChangeApiCompartmentRequest,ChangeApiCompartmentResponse> handler)

Description copied from interface: ApiGatewayAsync

Changes the API compartment.

Specified by:

changeApiCompartment in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeCertificateCompartment

public Future<ChangeCertificateCompartmentResponse> changeCertificateCompartment(ChangeCertificateCompartmentRequest request,
                                                                                 AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler)

Description copied from interface: ApiGatewayAsync

Changes the certificate compartment.

Specified by:

changeCertificateCompartment in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createApi

public Future<CreateApiResponse> createApi(CreateApiRequest request,
                                           AsyncHandler<CreateApiRequest,CreateApiResponse> handler)

Description copied from interface: ApiGatewayAsync

Creates a new API.

Specified by:

createApi in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createCertificate

public Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request,
                                                           AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)

Description copied from interface: ApiGatewayAsync

Creates a new Certificate.

Specified by:

createCertificate in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSdk

public Future<CreateSdkResponse> createSdk(CreateSdkRequest request,
                                           AsyncHandler<CreateSdkRequest,CreateSdkResponse> handler)

Description copied from interface: ApiGatewayAsync

Creates a new SDK.

Specified by:

createSdk in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteApi

public Future<DeleteApiResponse> deleteApi(DeleteApiRequest request,
                                           AsyncHandler<DeleteApiRequest,DeleteApiResponse> handler)

Description copied from interface: ApiGatewayAsync

Deletes the API with the given identifier.

Specified by:

deleteApi in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteCertificate

public Future<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest request,
                                                           AsyncHandler<DeleteCertificateRequest,DeleteCertificateResponse> handler)

Description copied from interface: ApiGatewayAsync

Deletes the certificate with the given identifier.

Specified by:

deleteCertificate in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSdk

public Future<DeleteSdkResponse> deleteSdk(DeleteSdkRequest request,
                                           AsyncHandler<DeleteSdkRequest,DeleteSdkResponse> handler)

Description copied from interface: ApiGatewayAsync

Deletes provided SDK.

Specified by:

deleteSdk in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getApi

public Future<GetApiResponse> getApi(GetApiRequest request,
                                     AsyncHandler<GetApiRequest,GetApiResponse> handler)

Description copied from interface: ApiGatewayAsync

Gets an API by identifier.

Specified by:

getApi in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getApiContent

public Future<GetApiContentResponse> getApiContent(GetApiContentRequest request,
                                                   AsyncHandler<GetApiContentRequest,GetApiContentResponse> handler)

Description copied from interface: ApiGatewayAsync

Get the raw API content.

Specified by:

getApiContent in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getApiDeploymentSpecification

public Future<GetApiDeploymentSpecificationResponse> getApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request,
                                                                                   AsyncHandler<GetApiDeploymentSpecificationRequest,GetApiDeploymentSpecificationResponse> handler)

Description copied from interface: ApiGatewayAsync

Gets an API Deployment specification by identifier.

Specified by:

getApiDeploymentSpecification in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getApiValidations

public Future<GetApiValidationsResponse> getApiValidations(GetApiValidationsRequest request,
                                                           AsyncHandler<GetApiValidationsRequest,GetApiValidationsResponse> handler)

Description copied from interface: ApiGatewayAsync

Gets the API validation results.

Specified by:

getApiValidations in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getCertificate

public Future<GetCertificateResponse> getCertificate(GetCertificateRequest request,
                                                     AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)

Description copied from interface: ApiGatewayAsync

Gets a certificate by identifier.

Specified by:

getCertificate in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSdk

public Future<GetSdkResponse> getSdk(GetSdkRequest request,
                                     AsyncHandler<GetSdkRequest,GetSdkResponse> handler)

Description copied from interface: ApiGatewayAsync

Return object store downloadable URL and metadata.

Specified by:

getSdk in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listApis

public Future<ListApisResponse> listApis(ListApisRequest request,
                                         AsyncHandler<ListApisRequest,ListApisResponse> handler)

Description copied from interface: ApiGatewayAsync

Returns a list of APIs.

Specified by:

listApis in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listCertificates

public Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request,
                                                         AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)

Description copied from interface: ApiGatewayAsync

Returns a list of certificates.

Specified by:

listCertificates in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSdkLanguageTypes

public Future<ListSdkLanguageTypesResponse> listSdkLanguageTypes(ListSdkLanguageTypesRequest request,
                                                                 AsyncHandler<ListSdkLanguageTypesRequest,ListSdkLanguageTypesResponse> handler)

Description copied from interface: ApiGatewayAsync

Lists programming languages in which SDK can be generated.

Specified by:

listSdkLanguageTypes in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSdks

public Future<ListSdksResponse> listSdks(ListSdksRequest request,
                                         AsyncHandler<ListSdksRequest,ListSdksResponse> handler)

Description copied from interface: ApiGatewayAsync

Returns list of generated SDKs.

Specified by:

listSdks in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateApi

public Future<UpdateApiResponse> updateApi(UpdateApiRequest request,
                                           AsyncHandler<UpdateApiRequest,UpdateApiResponse> handler)

Description copied from interface: ApiGatewayAsync

Updates the API with the given identifier.

Specified by:

updateApi in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateCertificate

public Future<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest request,
                                                           AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler)

Description copied from interface: ApiGatewayAsync

Updates a certificate with the given identifier

Specified by:

updateCertificate in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSdk

public Future<UpdateSdkResponse> updateSdk(UpdateSdkRequest request,
                                           AsyncHandler<UpdateSdkRequest,UpdateSdkResponse> handler)

Description copied from interface: ApiGatewayAsync

Updates the SDK with the given identifier.

Specified by:

updateSdk in interface ApiGatewayAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)