com.oracle.bmc.apigateway.ApiGatewayAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-apigateway Show documentation
/**
* Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.apigateway;
import com.oracle.bmc.apigateway.requests.*;
import com.oracle.bmc.apigateway.responses.*;
/**
* API for the API Gateway service. Use this API to manage gateways, deployments, and related items.
* For more information, see
* [Overview of API Gateway](https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).
*
*/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
public interface ApiGatewayAsync extends AutoCloseable {
/**
* Sets the endpoint to call (ex, https://www.example.com).
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/**
* Gets the set endpoint for REST call (ex, https://www.example.com)
*/
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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
* {@link #setRegion(Region) setRegion}.
*
* If no known Region could be determined, it will create an endpoint based on the
* default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* Changes the API compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future changeApiCompartment(
ChangeApiCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeApiCompartmentRequest, ChangeApiCompartmentResponse>
handler);
/**
* Changes the certificate compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future changeCertificateCompartment(
ChangeCertificateCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeCertificateCompartmentRequest,
ChangeCertificateCompartmentResponse>
handler);
/**
* Creates a new API.
*
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createApi(
CreateApiRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Creates a new Certificate.
*
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createCertificate(
CreateCertificateRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateCertificateRequest, CreateCertificateResponse>
handler);
/**
* Creates a new SDK.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createSdk(
CreateSdkRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Deletes the API with the given identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteApi(
DeleteApiRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Deletes the certificate with the given identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteCertificate(
DeleteCertificateRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteCertificateRequest, DeleteCertificateResponse>
handler);
/**
* Deletes provided SDK.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteSdk(
DeleteSdkRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Gets an API by identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getApi(
GetApiRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Get the raw API content.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getApiContent(
GetApiContentRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Gets an API Deployment specification by identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
getApiDeploymentSpecification(
GetApiDeploymentSpecificationRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetApiDeploymentSpecificationRequest,
GetApiDeploymentSpecificationResponse>
handler);
/**
* Gets the API validation results.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getApiValidations(
GetApiValidationsRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetApiValidationsRequest, GetApiValidationsResponse>
handler);
/**
* Gets a certificate by identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getCertificate(
GetCertificateRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Return object store downloadable URL and metadata.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getSdk(
GetSdkRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Returns a list of APIs.
*
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listApis(
ListApisRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Returns a list of certificates.
*
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listCertificates(
ListCertificatesRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Lists programming languages in which SDK can be generated.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listSdkLanguageTypes(
ListSdkLanguageTypesRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListSdkLanguageTypesRequest, ListSdkLanguageTypesResponse>
handler);
/**
* Returns list of generated SDKs.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listSdks(
ListSdksRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Updates the API with the given identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateApi(
UpdateApiRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Updates a certificate with the given identifier
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateCertificate(
UpdateCertificateRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateCertificateRequest, UpdateCertificateResponse>
handler);
/**
* Updates the SDK with the given identifier.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateSdk(
UpdateSdkRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
}