software.amazon.awssdk.services.apigateway.ApiGatewayAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.apigateway;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.apigateway.model.CreateApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.CreateApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.CreateAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.CreateAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.CreateDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.CreateDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.CreateModelRequest;
import software.amazon.awssdk.services.apigateway.model.CreateModelResponse;
import software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.CreateResourceRequest;
import software.amazon.awssdk.services.apigateway.model.CreateResourceResponse;
import software.amazon.awssdk.services.apigateway.model.CreateRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.CreateRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.CreateStageRequest;
import software.amazon.awssdk.services.apigateway.model.CreateStageResponse;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.CreateUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.CreateVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.CreateVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteModelRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteModelResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteResourceRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteResourceResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteStageRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteStageResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheRequest;
import software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheResponse;
import software.amazon.awssdk.services.apigateway.model.FlushStageCacheRequest;
import software.amazon.awssdk.services.apigateway.model.FlushStageCacheResponse;
import software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.GetAccountRequest;
import software.amazon.awssdk.services.apigateway.model.GetAccountResponse;
import software.amazon.awssdk.services.apigateway.model.GetApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.GetApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest;
import software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizersRequest;
import software.amazon.awssdk.services.apigateway.model.GetAuthorizersResponse;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest;
import software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest;
import software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsRequest;
import software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsResponse;
import software.amazon.awssdk.services.apigateway.model.GetDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.GetDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest;
import software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse;
import software.amazon.awssdk.services.apigateway.model.GetExportRequest;
import software.amazon.awssdk.services.apigateway.model.GetExportResponse;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest;
import software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesResponse;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetMethodRequest;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponse;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.GetMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelTemplateRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelTemplateResponse;
import software.amazon.awssdk.services.apigateway.model.GetModelsRequest;
import software.amazon.awssdk.services.apigateway.model.GetModelsResponse;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsRequest;
import software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsResponse;
import software.amazon.awssdk.services.apigateway.model.GetResourceRequest;
import software.amazon.awssdk.services.apigateway.model.GetResourceResponse;
import software.amazon.awssdk.services.apigateway.model.GetResourcesRequest;
import software.amazon.awssdk.services.apigateway.model.GetResourcesResponse;
import software.amazon.awssdk.services.apigateway.model.GetRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.GetRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.GetRestApisRequest;
import software.amazon.awssdk.services.apigateway.model.GetRestApisResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypeRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypeResponse;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypesRequest;
import software.amazon.awssdk.services.apigateway.model.GetSdkTypesResponse;
import software.amazon.awssdk.services.apigateway.model.GetStageRequest;
import software.amazon.awssdk.services.apigateway.model.GetStageResponse;
import software.amazon.awssdk.services.apigateway.model.GetStagesRequest;
import software.amazon.awssdk.services.apigateway.model.GetStagesResponse;
import software.amazon.awssdk.services.apigateway.model.GetTagsRequest;
import software.amazon.awssdk.services.apigateway.model.GetTagsResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeyRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeyResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse;
import software.amazon.awssdk.services.apigateway.model.GetUsageRequest;
import software.amazon.awssdk.services.apigateway.model.GetUsageResponse;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest;
import software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse;
import software.amazon.awssdk.services.apigateway.model.ImportApiKeysRequest;
import software.amazon.awssdk.services.apigateway.model.ImportApiKeysResponse;
import software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest;
import software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsResponse;
import software.amazon.awssdk.services.apigateway.model.ImportRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.ImportRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.PutGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutMethodRequest;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponse;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.PutMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.PutRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.PutRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.TagResourceRequest;
import software.amazon.awssdk.services.apigateway.model.TagResourceResponse;
import software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.TestInvokeMethodRequest;
import software.amazon.awssdk.services.apigateway.model.TestInvokeMethodResponse;
import software.amazon.awssdk.services.apigateway.model.UntagResourceRequest;
import software.amazon.awssdk.services.apigateway.model.UntagResourceResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateAccountRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateAccountResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateApiKeyRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateApiKeyResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateAuthorizerRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateAuthorizerResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateBasePathMappingRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateBasePathMappingResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateClientCertificateRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateClientCertificateResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDeploymentRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDeploymentResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationVersionRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDocumentationVersionResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateDomainNameRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateDomainNameResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponseRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateMethodResponseResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateModelRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateModelResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateRequestValidatorRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateRequestValidatorResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateResourceRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateResourceResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateRestApiRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateRestApiResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateStageRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateStageResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateUsageRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateUsageResponse;
import software.amazon.awssdk.services.apigateway.model.UpdateVpcLinkRequest;
import software.amazon.awssdk.services.apigateway.model.UpdateVpcLinkResponse;
import software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher;
import software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher;
/**
* Service client for accessing Amazon API Gateway asynchronously. This can be created using the static
* {@link #builder()} method.The asynchronous client performs non-blocking I/O when configured with any
* {@code SdkAsyncHttpClient} supported in the SDK. However, full non-blocking is not guaranteed as the async client may
* perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
* call.
*
* Amazon API Gateway
*
* Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API
* Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or
* other publicly addressable web services that are hosted outside of AWS.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface ApiGatewayAsyncClient extends AwsClient {
String SERVICE_NAME = "apigateway";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "apigateway";
/**
*
* Create an ApiKey resource.
*
*
* @param createApiKeyRequest
* Request to create an ApiKey resource.
* @return A Java Future containing the result of the CreateApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateApiKey
*/
default CompletableFuture createApiKey(CreateApiKeyRequest createApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Create an ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link CreateApiKeyRequest#builder()}
*
*
* @param createApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateApiKeyRequest.Builder} to create a request.
* Request to create an ApiKey resource.
* @return A Java Future containing the result of the CreateApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateApiKey
*/
default CompletableFuture createApiKey(Consumer createApiKeyRequest) {
return createApiKey(CreateApiKeyRequest.builder().applyMutation(createApiKeyRequest).build());
}
/**
*
* Create an ApiKey resource.
*
*
* @return A Java Future containing the result of the CreateApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateApiKey
*/
default CompletableFuture createApiKey() {
return createApiKey(CreateApiKeyRequest.builder().build());
}
/**
*
* Adds a new Authorizer resource to an existing RestApi resource.
*
*
* @param createAuthorizerRequest
* Request to add a new Authorizer to an existing RestApi resource.
* @return A Java Future containing the result of the CreateAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateAuthorizer
*/
default CompletableFuture createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a new Authorizer resource to an existing RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAuthorizerRequest.Builder} avoiding the need
* to create one manually via {@link CreateAuthorizerRequest#builder()}
*
*
* @param createAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateAuthorizerRequest.Builder} to create a
* request. Request to add a new Authorizer to an existing RestApi resource.
* @return A Java Future containing the result of the CreateAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateAuthorizer
*/
default CompletableFuture createAuthorizer(
Consumer createAuthorizerRequest) {
return createAuthorizer(CreateAuthorizerRequest.builder().applyMutation(createAuthorizerRequest).build());
}
/**
*
* Creates a new BasePathMapping resource.
*
*
* @param createBasePathMappingRequest
* Requests API Gateway to create a new BasePathMapping resource.
* @return A Java Future containing the result of the CreateBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateBasePathMapping
*/
default CompletableFuture createBasePathMapping(
CreateBasePathMappingRequest createBasePathMappingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link CreateBasePathMappingRequest#builder()}
*
*
* @param createBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateBasePathMappingRequest.Builder} to create a
* request. Requests API Gateway to create a new BasePathMapping resource.
* @return A Java Future containing the result of the CreateBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateBasePathMapping
*/
default CompletableFuture createBasePathMapping(
Consumer createBasePathMappingRequest) {
return createBasePathMapping(CreateBasePathMappingRequest.builder().applyMutation(createBasePathMappingRequest).build());
}
/**
*
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*
*
* @param createDeploymentRequest
* Requests API Gateway to create a Deployment resource.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDeployment
*/
default CompletableFuture createDeployment(CreateDeploymentRequest createDeploymentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link CreateDeploymentRequest#builder()}
*
*
* @param createDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDeploymentRequest.Builder} to create a
* request. Requests API Gateway to create a Deployment resource.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDeployment
*/
default CompletableFuture createDeployment(
Consumer createDeploymentRequest) {
return createDeployment(CreateDeploymentRequest.builder().applyMutation(createDeploymentRequest).build());
}
/**
*
* Creates a documentation part.
*
*
* @param createDocumentationPartRequest
* Creates a new documentation part of a given API.
* @return A Java Future containing the result of the CreateDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDocumentationPart
*/
default CompletableFuture createDocumentationPart(
CreateDocumentationPartRequest createDocumentationPartRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a documentation part.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDocumentationPartRequest.Builder} avoiding
* the need to create one manually via {@link CreateDocumentationPartRequest#builder()}
*
*
* @param createDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartRequest.Builder} to create
* a request. Creates a new documentation part of a given API.
* @return A Java Future containing the result of the CreateDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDocumentationPart
*/
default CompletableFuture createDocumentationPart(
Consumer createDocumentationPartRequest) {
return createDocumentationPart(CreateDocumentationPartRequest.builder().applyMutation(createDocumentationPartRequest)
.build());
}
/**
*
* Creates a documentation version
*
*
* @param createDocumentationVersionRequest
* Creates a new documentation version of a given API.
* @return A Java Future containing the result of the CreateDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDocumentationVersion
*/
default CompletableFuture createDocumentationVersion(
CreateDocumentationVersionRequest createDocumentationVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a documentation version
*
*
*
* This is a convenience which creates an instance of the {@link CreateDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link CreateDocumentationVersionRequest#builder()}
*
*
* @param createDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionRequest.Builder} to
* create a request. Creates a new documentation version of a given API.
* @return A Java Future containing the result of the CreateDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDocumentationVersion
*/
default CompletableFuture createDocumentationVersion(
Consumer createDocumentationVersionRequest) {
return createDocumentationVersion(CreateDocumentationVersionRequest.builder()
.applyMutation(createDocumentationVersionRequest).build());
}
/**
*
* Creates a new domain name.
*
*
* @param createDomainNameRequest
* A request to create a new domain name.
* @return A Java Future containing the result of the CreateDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDomainName
*/
default CompletableFuture createDomainName(CreateDomainNameRequest createDomainNameRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new domain name.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDomainNameRequest.Builder} avoiding the need
* to create one manually via {@link CreateDomainNameRequest#builder()}
*
*
* @param createDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateDomainNameRequest.Builder} to create a
* request. A request to create a new domain name.
* @return A Java Future containing the result of the CreateDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateDomainName
*/
default CompletableFuture createDomainName(
Consumer createDomainNameRequest) {
return createDomainName(CreateDomainNameRequest.builder().applyMutation(createDomainNameRequest).build());
}
/**
*
* Adds a new Model resource to an existing RestApi resource.
*
*
* @param createModelRequest
* Request to add a new Model to an existing RestApi resource.
* @return A Java Future containing the result of the CreateModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateModel
*/
default CompletableFuture createModel(CreateModelRequest createModelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a new Model resource to an existing RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateModelRequest.Builder} avoiding the need to
* create one manually via {@link CreateModelRequest#builder()}
*
*
* @param createModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateModelRequest.Builder} to create a request.
* Request to add a new Model to an existing RestApi resource.
* @return A Java Future containing the result of the CreateModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateModel
*/
default CompletableFuture createModel(Consumer createModelRequest) {
return createModel(CreateModelRequest.builder().applyMutation(createModelRequest).build());
}
/**
*
* Creates a RequestValidator of a given RestApi.
*
*
* @param createRequestValidatorRequest
* Creates a RequestValidator of a given RestApi.
* @return A Java Future containing the result of the CreateRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateRequestValidator
*/
default CompletableFuture createRequestValidator(
CreateRequestValidatorRequest createRequestValidatorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link CreateRequestValidatorRequest#builder()}
*
*
* @param createRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorRequest.Builder} to create a
* request. Creates a RequestValidator of a given RestApi.
* @return A Java Future containing the result of the CreateRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateRequestValidator
*/
default CompletableFuture createRequestValidator(
Consumer createRequestValidatorRequest) {
return createRequestValidator(CreateRequestValidatorRequest.builder().applyMutation(createRequestValidatorRequest)
.build());
}
/**
*
* Creates a Resource resource.
*
*
* @param createResourceRequest
* Requests API Gateway to create a Resource resource.
* @return A Java Future containing the result of the CreateResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateResource
*/
default CompletableFuture createResource(CreateResourceRequest createResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateResourceRequest.Builder} avoiding the need to
* create one manually via {@link CreateResourceRequest#builder()}
*
*
* @param createResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateResourceRequest.Builder} to create a
* request. Requests API Gateway to create a Resource resource.
* @return A Java Future containing the result of the CreateResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateResource
*/
default CompletableFuture createResource(Consumer createResourceRequest) {
return createResource(CreateResourceRequest.builder().applyMutation(createResourceRequest).build());
}
/**
*
* Creates a new RestApi resource.
*
*
* @param createRestApiRequest
* The POST Request to add a new RestApi resource to your collection.
* @return A Java Future containing the result of the CreateRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateRestApi
*/
default CompletableFuture createRestApi(CreateRestApiRequest createRestApiRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRestApiRequest.Builder} avoiding the need to
* create one manually via {@link CreateRestApiRequest#builder()}
*
*
* @param createRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateRestApiRequest.Builder} to create a request.
* The POST Request to add a new RestApi resource to your collection.
* @return A Java Future containing the result of the CreateRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateRestApi
*/
default CompletableFuture createRestApi(Consumer createRestApiRequest) {
return createRestApi(CreateRestApiRequest.builder().applyMutation(createRestApiRequest).build());
}
/**
*
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*
*
* @param createStageRequest
* Requests API Gateway to create a Stage resource.
* @return A Java Future containing the result of the CreateStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateStage
*/
default CompletableFuture createStage(CreateStageRequest createStageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Stage resource that references a pre-existing Deployment for the API.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStageRequest.Builder} avoiding the need to
* create one manually via {@link CreateStageRequest#builder()}
*
*
* @param createStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateStageRequest.Builder} to create a request.
* Requests API Gateway to create a Stage resource.
* @return A Java Future containing the result of the CreateStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateStage
*/
default CompletableFuture createStage(Consumer createStageRequest) {
return createStage(CreateStageRequest.builder().applyMutation(createStageRequest).build());
}
/**
*
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
* payload.
*
*
* @param createUsagePlanRequest
* The POST request to create a usage plan with the name, description, throttle limits and quota limits, as
* well as the associated API stages, specified in the payload.
* @return A Java Future containing the result of the CreateUsagePlan operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateUsagePlan
*/
default CompletableFuture createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
* payload.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUsagePlanRequest.Builder} avoiding the need
* to create one manually via {@link CreateUsagePlanRequest#builder()}
*
*
* @param createUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest.Builder} to create a
* request. The POST request to create a usage plan with the name, description, throttle limits and quota
* limits, as well as the associated API stages, specified in the payload.
* @return A Java Future containing the result of the CreateUsagePlan operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateUsagePlan
*/
default CompletableFuture createUsagePlan(
Consumer createUsagePlanRequest) {
return createUsagePlan(CreateUsagePlanRequest.builder().applyMutation(createUsagePlanRequest).build());
}
/**
*
* Creates a usage plan key for adding an existing API key to a usage plan.
*
*
* @param createUsagePlanKeyRequest
* The POST request to create a usage plan key for adding an existing API key to a usage plan.
* @return A Java Future containing the result of the CreateUsagePlanKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateUsagePlanKey
*/
default CompletableFuture createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a usage plan key for adding an existing API key to a usage plan.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUsagePlanKeyRequest.Builder} avoiding the
* need to create one manually via {@link CreateUsagePlanKeyRequest#builder()}
*
*
* @param createUsagePlanKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyRequest.Builder} to create a
* request. The POST request to create a usage plan key for adding an existing API key to a usage plan.
* @return A Java Future containing the result of the CreateUsagePlanKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateUsagePlanKey
*/
default CompletableFuture createUsagePlanKey(
Consumer createUsagePlanKeyRequest) {
return createUsagePlanKey(CreateUsagePlanKeyRequest.builder().applyMutation(createUsagePlanKeyRequest).build());
}
/**
*
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
* takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC
* Endpoint services.
*
*
* @param createVpcLinkRequest
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
* typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
* and update VPC Endpoint services.
* @return A Java Future containing the result of the CreateVpcLink operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateVpcLink
*/
default CompletableFuture createVpcLink(CreateVpcLinkRequest createVpcLinkRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
* takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC
* Endpoint services.
*
*
*
* This is a convenience which creates an instance of the {@link CreateVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link CreateVpcLinkRequest#builder()}
*
*
* @param createVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.CreateVpcLinkRequest.Builder} to create a request.
* Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
* typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
* and update VPC Endpoint services.
* @return A Java Future containing the result of the CreateVpcLink operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.CreateVpcLink
*/
default CompletableFuture createVpcLink(Consumer createVpcLinkRequest) {
return createVpcLink(CreateVpcLinkRequest.builder().applyMutation(createVpcLinkRequest).build());
}
/**
*
* Deletes the ApiKey resource.
*
*
* @param deleteApiKeyRequest
* A request to delete the ApiKey resource.
* @return A Java Future containing the result of the DeleteApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteApiKey
*/
default CompletableFuture deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link DeleteApiKeyRequest#builder()}
*
*
* @param deleteApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteApiKeyRequest.Builder} to create a request.
* A request to delete the ApiKey resource.
* @return A Java Future containing the result of the DeleteApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteApiKey
*/
default CompletableFuture deleteApiKey(Consumer deleteApiKeyRequest) {
return deleteApiKey(DeleteApiKeyRequest.builder().applyMutation(deleteApiKeyRequest).build());
}
/**
*
* Deletes an existing Authorizer resource.
*
*
* @param deleteAuthorizerRequest
* Request to delete an existing Authorizer resource.
* @return A Java Future containing the result of the DeleteAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteAuthorizer
*/
default CompletableFuture deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing Authorizer resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAuthorizerRequest.Builder} avoiding the need
* to create one manually via {@link DeleteAuthorizerRequest#builder()}
*
*
* @param deleteAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteAuthorizerRequest.Builder} to create a
* request. Request to delete an existing Authorizer resource.
* @return A Java Future containing the result of the DeleteAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteAuthorizer
*/
default CompletableFuture deleteAuthorizer(
Consumer deleteAuthorizerRequest) {
return deleteAuthorizer(DeleteAuthorizerRequest.builder().applyMutation(deleteAuthorizerRequest).build());
}
/**
*
* Deletes the BasePathMapping resource.
*
*
* @param deleteBasePathMappingRequest
* A request to delete the BasePathMapping resource.
* @return A Java Future containing the result of the DeleteBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteBasePathMapping
*/
default CompletableFuture deleteBasePathMapping(
DeleteBasePathMappingRequest deleteBasePathMappingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBasePathMappingRequest#builder()}
*
*
* @param deleteBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteBasePathMappingRequest.Builder} to create a
* request. A request to delete the BasePathMapping resource.
* @return A Java Future containing the result of the DeleteBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteBasePathMapping
*/
default CompletableFuture deleteBasePathMapping(
Consumer deleteBasePathMappingRequest) {
return deleteBasePathMapping(DeleteBasePathMappingRequest.builder().applyMutation(deleteBasePathMappingRequest).build());
}
/**
*
* Deletes the ClientCertificate resource.
*
*
* @param deleteClientCertificateRequest
* A request to delete the ClientCertificate resource.
* @return A Java Future containing the result of the DeleteClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteClientCertificate
*/
default CompletableFuture deleteClientCertificate(
DeleteClientCertificateRequest deleteClientCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteClientCertificateRequest.Builder} avoiding
* the need to create one manually via {@link DeleteClientCertificateRequest#builder()}
*
*
* @param deleteClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteClientCertificateRequest.Builder} to create
* a request. A request to delete the ClientCertificate resource.
* @return A Java Future containing the result of the DeleteClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteClientCertificate
*/
default CompletableFuture deleteClientCertificate(
Consumer deleteClientCertificateRequest) {
return deleteClientCertificate(DeleteClientCertificateRequest.builder().applyMutation(deleteClientCertificateRequest)
.build());
}
/**
*
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated
* with it.
*
*
* @param deleteDeploymentRequest
* Requests API Gateway to delete a Deployment resource.
* @return A Java Future containing the result of the DeleteDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDeployment
*/
default CompletableFuture deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated
* with it.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDeploymentRequest#builder()}
*
*
* @param deleteDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDeploymentRequest.Builder} to create a
* request. Requests API Gateway to delete a Deployment resource.
* @return A Java Future containing the result of the DeleteDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDeployment
*/
default CompletableFuture deleteDeployment(
Consumer deleteDeploymentRequest) {
return deleteDeployment(DeleteDeploymentRequest.builder().applyMutation(deleteDeploymentRequest).build());
}
/**
*
* Deletes a documentation part
*
*
* @param deleteDocumentationPartRequest
* Deletes an existing documentation part of an API.
* @return A Java Future containing the result of the DeleteDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDocumentationPart
*/
default CompletableFuture deleteDocumentationPart(
DeleteDocumentationPartRequest deleteDocumentationPartRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a documentation part
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDocumentationPartRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDocumentationPartRequest#builder()}
*
*
* @param deleteDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDocumentationPartRequest.Builder} to create
* a request. Deletes an existing documentation part of an API.
* @return A Java Future containing the result of the DeleteDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDocumentationPart
*/
default CompletableFuture deleteDocumentationPart(
Consumer deleteDocumentationPartRequest) {
return deleteDocumentationPart(DeleteDocumentationPartRequest.builder().applyMutation(deleteDocumentationPartRequest)
.build());
}
/**
*
* Deletes a documentation version.
*
*
* @param deleteDocumentationVersionRequest
* Deletes an existing documentation version of an API.
* @return A Java Future containing the result of the DeleteDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDocumentationVersion
*/
default CompletableFuture deleteDocumentationVersion(
DeleteDocumentationVersionRequest deleteDocumentationVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a documentation version.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDocumentationVersionRequest#builder()}
*
*
* @param deleteDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDocumentationVersionRequest.Builder} to
* create a request. Deletes an existing documentation version of an API.
* @return A Java Future containing the result of the DeleteDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDocumentationVersion
*/
default CompletableFuture deleteDocumentationVersion(
Consumer deleteDocumentationVersionRequest) {
return deleteDocumentationVersion(DeleteDocumentationVersionRequest.builder()
.applyMutation(deleteDocumentationVersionRequest).build());
}
/**
*
* Deletes the DomainName resource.
*
*
* @param deleteDomainNameRequest
* A request to delete the DomainName resource.
* @return A Java Future containing the result of the DeleteDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDomainName
*/
default CompletableFuture deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the DomainName resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDomainNameRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDomainNameRequest#builder()}
*
*
* @param deleteDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteDomainNameRequest.Builder} to create a
* request. A request to delete the DomainName resource.
* @return A Java Future containing the result of the DeleteDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteDomainName
*/
default CompletableFuture deleteDomainName(
Consumer deleteDomainNameRequest) {
return deleteDomainName(DeleteDomainNameRequest.builder().applyMutation(deleteDomainNameRequest).build());
}
/**
*
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
* with the default settings.
*
*
* @param deleteGatewayResponseRequest
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets
* it with the default settings.
* @return A Java Future containing the result of the DeleteGatewayResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteGatewayResponse
*/
default CompletableFuture deleteGatewayResponse(
DeleteGatewayResponseRequest deleteGatewayResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
* with the default settings.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link DeleteGatewayResponseRequest#builder()}
*
*
* @param deleteGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteGatewayResponseRequest.Builder} to create a
* request. Clears any customization of a GatewayResponse of a specified response type on the given RestApi
* and resets it with the default settings.
* @return A Java Future containing the result of the DeleteGatewayResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteGatewayResponse
*/
default CompletableFuture deleteGatewayResponse(
Consumer deleteGatewayResponseRequest) {
return deleteGatewayResponse(DeleteGatewayResponseRequest.builder().applyMutation(deleteGatewayResponseRequest).build());
}
/**
*
* Represents a delete integration.
*
*
* @param deleteIntegrationRequest
* Represents a delete integration request.
* @return A Java Future containing the result of the DeleteIntegration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteIntegration
*/
default CompletableFuture deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a delete integration.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIntegrationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteIntegrationRequest#builder()}
*
*
* @param deleteIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteIntegrationRequest.Builder} to create a
* request. Represents a delete integration request.
* @return A Java Future containing the result of the DeleteIntegration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteIntegration
*/
default CompletableFuture deleteIntegration(
Consumer deleteIntegrationRequest) {
return deleteIntegration(DeleteIntegrationRequest.builder().applyMutation(deleteIntegrationRequest).build());
}
/**
*
* Represents a delete integration response.
*
*
* @param deleteIntegrationResponseRequest
* Represents a delete integration response request.
* @return A Java Future containing the result of the DeleteIntegrationResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteIntegrationResponse
*/
default CompletableFuture deleteIntegrationResponse(
DeleteIntegrationResponseRequest deleteIntegrationResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a delete integration response.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIntegrationResponseRequest.Builder} avoiding
* the need to create one manually via {@link DeleteIntegrationResponseRequest#builder()}
*
*
* @param deleteIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteIntegrationResponseRequest.Builder} to
* create a request. Represents a delete integration response request.
* @return A Java Future containing the result of the DeleteIntegrationResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteIntegrationResponse
*/
default CompletableFuture deleteIntegrationResponse(
Consumer deleteIntegrationResponseRequest) {
return deleteIntegrationResponse(DeleteIntegrationResponseRequest.builder()
.applyMutation(deleteIntegrationResponseRequest).build());
}
/**
*
* Deletes an existing Method resource.
*
*
* @param deleteMethodRequest
* Request to delete an existing Method resource.
* @return A Java Future containing the result of the DeleteMethod operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteMethod
*/
default CompletableFuture deleteMethod(DeleteMethodRequest deleteMethodRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMethodRequest.Builder} avoiding the need to
* create one manually via {@link DeleteMethodRequest#builder()}
*
*
* @param deleteMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteMethodRequest.Builder} to create a request.
* Request to delete an existing Method resource.
* @return A Java Future containing the result of the DeleteMethod operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteMethod
*/
default CompletableFuture deleteMethod(Consumer deleteMethodRequest) {
return deleteMethod(DeleteMethodRequest.builder().applyMutation(deleteMethodRequest).build());
}
/**
*
* Deletes an existing MethodResponse resource.
*
*
* @param deleteMethodResponseRequest
* A request to delete an existing MethodResponse resource.
* @return A Java Future containing the result of the DeleteMethodResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteMethodResponse
*/
default CompletableFuture deleteMethodResponse(
DeleteMethodResponseRequest deleteMethodResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing MethodResponse resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMethodResponseRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMethodResponseRequest#builder()}
*
*
* @param deleteMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteMethodResponseRequest.Builder} to create a
* request. A request to delete an existing MethodResponse resource.
* @return A Java Future containing the result of the DeleteMethodResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteMethodResponse
*/
default CompletableFuture deleteMethodResponse(
Consumer deleteMethodResponseRequest) {
return deleteMethodResponse(DeleteMethodResponseRequest.builder().applyMutation(deleteMethodResponseRequest).build());
}
/**
*
* Deletes a model.
*
*
* @param deleteModelRequest
* Request to delete an existing model in an existing RestApi resource.
* @return A Java Future containing the result of the DeleteModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteModel
*/
default CompletableFuture deleteModel(DeleteModelRequest deleteModelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a model.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteModelRequest.Builder} avoiding the need to
* create one manually via {@link DeleteModelRequest#builder()}
*
*
* @param deleteModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteModelRequest.Builder} to create a request.
* Request to delete an existing model in an existing RestApi resource.
* @return A Java Future containing the result of the DeleteModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteModel
*/
default CompletableFuture deleteModel(Consumer deleteModelRequest) {
return deleteModel(DeleteModelRequest.builder().applyMutation(deleteModelRequest).build());
}
/**
*
* Deletes a RequestValidator of a given RestApi.
*
*
* @param deleteRequestValidatorRequest
* Deletes a specified RequestValidator of a given RestApi.
* @return A Java Future containing the result of the DeleteRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteRequestValidator
*/
default CompletableFuture deleteRequestValidator(
DeleteRequestValidatorRequest deleteRequestValidatorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRequestValidatorRequest#builder()}
*
*
* @param deleteRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteRequestValidatorRequest.Builder} to create a
* request. Deletes a specified RequestValidator of a given RestApi.
* @return A Java Future containing the result of the DeleteRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteRequestValidator
*/
default CompletableFuture deleteRequestValidator(
Consumer deleteRequestValidatorRequest) {
return deleteRequestValidator(DeleteRequestValidatorRequest.builder().applyMutation(deleteRequestValidatorRequest)
.build());
}
/**
*
* Deletes a Resource resource.
*
*
* @param deleteResourceRequest
* Request to delete a Resource.
* @return A Java Future containing the result of the DeleteResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteResource
*/
default CompletableFuture deleteResource(DeleteResourceRequest deleteResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Resource resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteResourceRequest.Builder} avoiding the need to
* create one manually via {@link DeleteResourceRequest#builder()}
*
*
* @param deleteResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteResourceRequest.Builder} to create a
* request. Request to delete a Resource.
* @return A Java Future containing the result of the DeleteResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteResource
*/
default CompletableFuture deleteResource(Consumer deleteResourceRequest) {
return deleteResource(DeleteResourceRequest.builder().applyMutation(deleteResourceRequest).build());
}
/**
*
* Deletes the specified API.
*
*
* @param deleteRestApiRequest
* Request to delete the specified API from your collection.
* @return A Java Future containing the result of the DeleteRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteRestApi
*/
default CompletableFuture deleteRestApi(DeleteRestApiRequest deleteRestApiRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified API.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRestApiRequest.Builder} avoiding the need to
* create one manually via {@link DeleteRestApiRequest#builder()}
*
*
* @param deleteRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteRestApiRequest.Builder} to create a request.
* Request to delete the specified API from your collection.
* @return A Java Future containing the result of the DeleteRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteRestApi
*/
default CompletableFuture deleteRestApi(Consumer deleteRestApiRequest) {
return deleteRestApi(DeleteRestApiRequest.builder().applyMutation(deleteRestApiRequest).build());
}
/**
*
* Deletes a Stage resource.
*
*
* @param deleteStageRequest
* Requests API Gateway to delete a Stage resource.
* @return A Java Future containing the result of the DeleteStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteStage
*/
default CompletableFuture deleteStage(DeleteStageRequest deleteStageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Stage resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteStageRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStageRequest#builder()}
*
*
* @param deleteStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteStageRequest.Builder} to create a request.
* Requests API Gateway to delete a Stage resource.
* @return A Java Future containing the result of the DeleteStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteStage
*/
default CompletableFuture deleteStage(Consumer deleteStageRequest) {
return deleteStage(DeleteStageRequest.builder().applyMutation(deleteStageRequest).build());
}
/**
*
* Deletes a usage plan of a given plan Id.
*
*
* @param deleteUsagePlanRequest
* The DELETE request to delete a usage plan of a given plan Id.
* @return A Java Future containing the result of the DeleteUsagePlan operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteUsagePlan
*/
default CompletableFuture deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a usage plan of a given plan Id.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUsagePlanRequest.Builder} avoiding the need
* to create one manually via {@link DeleteUsagePlanRequest#builder()}
*
*
* @param deleteUsagePlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanRequest.Builder} to create a
* request. The DELETE request to delete a usage plan of a given plan Id.
* @return A Java Future containing the result of the DeleteUsagePlan operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteUsagePlan
*/
default CompletableFuture deleteUsagePlan(
Consumer deleteUsagePlanRequest) {
return deleteUsagePlan(DeleteUsagePlanRequest.builder().applyMutation(deleteUsagePlanRequest).build());
}
/**
*
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*
*
* @param deleteUsagePlanKeyRequest
* The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
* plan.
* @return A Java Future containing the result of the DeleteUsagePlanKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteUsagePlanKey
*/
default CompletableFuture deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUsagePlanKeyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteUsagePlanKeyRequest#builder()}
*
*
* @param deleteUsagePlanKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteUsagePlanKeyRequest.Builder} to create a
* request. The DELETE request to delete a usage plan key and remove the underlying API key from the
* associated usage plan.
* @return A Java Future containing the result of the DeleteUsagePlanKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteUsagePlanKey
*/
default CompletableFuture deleteUsagePlanKey(
Consumer deleteUsagePlanKeyRequest) {
return deleteUsagePlanKey(DeleteUsagePlanKeyRequest.builder().applyMutation(deleteUsagePlanKeyRequest).build());
}
/**
*
* Deletes an existing VpcLink of a specified identifier.
*
*
* @param deleteVpcLinkRequest
* Deletes an existing VpcLink of a specified identifier.
* @return A Java Future containing the result of the DeleteVpcLink operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteVpcLink
*/
default CompletableFuture deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing VpcLink of a specified identifier.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteVpcLinkRequest.Builder} avoiding the need to
* create one manually via {@link DeleteVpcLinkRequest#builder()}
*
*
* @param deleteVpcLinkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.DeleteVpcLinkRequest.Builder} to create a request.
* Deletes an existing VpcLink of a specified identifier.
* @return A Java Future containing the result of the DeleteVpcLink operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.DeleteVpcLink
*/
default CompletableFuture deleteVpcLink(Consumer deleteVpcLinkRequest) {
return deleteVpcLink(DeleteVpcLinkRequest.builder().applyMutation(deleteVpcLinkRequest).build());
}
/**
*
* Flushes all authorizer cache entries on a stage.
*
*
* @param flushStageAuthorizersCacheRequest
* Request to flush authorizer cache entries on a specified stage.
* @return A Java Future containing the result of the FlushStageAuthorizersCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.FlushStageAuthorizersCache
*/
default CompletableFuture flushStageAuthorizersCache(
FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Flushes all authorizer cache entries on a stage.
*
*
*
* This is a convenience which creates an instance of the {@link FlushStageAuthorizersCacheRequest.Builder} avoiding
* the need to create one manually via {@link FlushStageAuthorizersCacheRequest#builder()}
*
*
* @param flushStageAuthorizersCacheRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.FlushStageAuthorizersCacheRequest.Builder} to
* create a request. Request to flush authorizer cache entries on a specified stage.
* @return A Java Future containing the result of the FlushStageAuthorizersCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.FlushStageAuthorizersCache
*/
default CompletableFuture flushStageAuthorizersCache(
Consumer flushStageAuthorizersCacheRequest) {
return flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest.builder()
.applyMutation(flushStageAuthorizersCacheRequest).build());
}
/**
*
* Flushes a stage's cache.
*
*
* @param flushStageCacheRequest
* Requests API Gateway to flush a stage's cache.
* @return A Java Future containing the result of the FlushStageCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.FlushStageCache
*/
default CompletableFuture flushStageCache(FlushStageCacheRequest flushStageCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Flushes a stage's cache.
*
*
*
* This is a convenience which creates an instance of the {@link FlushStageCacheRequest.Builder} avoiding the need
* to create one manually via {@link FlushStageCacheRequest#builder()}
*
*
* @param flushStageCacheRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.FlushStageCacheRequest.Builder} to create a
* request. Requests API Gateway to flush a stage's cache.
* @return A Java Future containing the result of the FlushStageCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.FlushStageCache
*/
default CompletableFuture flushStageCache(
Consumer flushStageCacheRequest) {
return flushStageCache(FlushStageCacheRequest.builder().applyMutation(flushStageCacheRequest).build());
}
/**
*
* Generates a ClientCertificate resource.
*
*
* @param generateClientCertificateRequest
* A request to generate a ClientCertificate resource.
* @return A Java Future containing the result of the GenerateClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GenerateClientCertificate
*/
default CompletableFuture generateClientCertificate(
GenerateClientCertificateRequest generateClientCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Generates a ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link GenerateClientCertificateRequest.Builder} avoiding
* the need to create one manually via {@link GenerateClientCertificateRequest#builder()}
*
*
* @param generateClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GenerateClientCertificateRequest.Builder} to
* create a request. A request to generate a ClientCertificate resource.
* @return A Java Future containing the result of the GenerateClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GenerateClientCertificate
*/
default CompletableFuture generateClientCertificate(
Consumer generateClientCertificateRequest) {
return generateClientCertificate(GenerateClientCertificateRequest.builder()
.applyMutation(generateClientCertificateRequest).build());
}
/**
*
* Generates a ClientCertificate resource.
*
*
* @return A Java Future containing the result of the GenerateClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GenerateClientCertificate
*/
default CompletableFuture generateClientCertificate() {
return generateClientCertificate(GenerateClientCertificateRequest.builder().build());
}
/**
*
* Gets information about the current Account resource.
*
*
* @param getAccountRequest
* Requests API Gateway to get information about the current Account resource.
* @return A Java Future containing the result of the GetAccount operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAccount
*/
default CompletableFuture getAccount(GetAccountRequest getAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current Account resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccountRequest.Builder} avoiding the need to
* create one manually via {@link GetAccountRequest#builder()}
*
*
* @param getAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAccountRequest.Builder} to create a request.
* Requests API Gateway to get information about the current Account resource.
* @return A Java Future containing the result of the GetAccount operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAccount
*/
default CompletableFuture getAccount(Consumer getAccountRequest) {
return getAccount(GetAccountRequest.builder().applyMutation(getAccountRequest).build());
}
/**
*
* Gets information about the current Account resource.
*
*
* @return A Java Future containing the result of the GetAccount operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAccount
*/
default CompletableFuture getAccount() {
return getAccount(GetAccountRequest.builder().build());
}
/**
*
* Gets information about the current ApiKey resource.
*
*
* @param getApiKeyRequest
* A request to get information about the current ApiKey resource.
* @return A Java Future containing the result of the GetApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKey
*/
default CompletableFuture getApiKey(GetApiKeyRequest getApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ApiKey resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeyRequest#builder()}
*
*
* @param getApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeyRequest.Builder} to create a request. A
* request to get information about the current ApiKey resource.
* @return A Java Future containing the result of the GetApiKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKey
*/
default CompletableFuture getApiKey(Consumer getApiKeyRequest) {
return getApiKey(GetApiKeyRequest.builder().applyMutation(getApiKeyRequest).build());
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
* @param getApiKeysRequest
* A request to get information about the current ApiKeys resource.
* @return A Java Future containing the result of the GetApiKeys operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default CompletableFuture getApiKeys(GetApiKeysRequest getApiKeysRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeysRequest#builder()}
*
*
* @param getApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest.Builder} to create a request. A
* request to get information about the current ApiKeys resource.
* @return A Java Future containing the result of the GetApiKeys operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default CompletableFuture getApiKeys(Consumer getApiKeysRequest) {
return getApiKeys(GetApiKeysRequest.builder().applyMutation(getApiKeysRequest).build());
}
/**
*
* Gets information about the current ApiKeys resource.
*
*
* @return A Java Future containing the result of the GetApiKeys operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default CompletableFuture getApiKeys() {
return getApiKeys(GetApiKeysRequest.builder().build());
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default GetApiKeysPublisher getApiKeysPaginator() {
return getApiKeysPaginator(GetApiKeysRequest.builder().build());
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
* @param getApiKeysRequest
* A request to get information about the current ApiKeys resource.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default GetApiKeysPublisher getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest) {
return new GetApiKeysPublisher(this, getApiKeysRequest);
}
/**
*
* This is a variant of {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link GetApiKeysRequest#builder()}
*
*
* @param getApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest.Builder} to create a request. A
* request to get information about the current ApiKeys resource.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetApiKeys
*/
default GetApiKeysPublisher getApiKeysPaginator(Consumer getApiKeysRequest) {
return getApiKeysPaginator(GetApiKeysRequest.builder().applyMutation(getApiKeysRequest).build());
}
/**
*
* Describe an existing Authorizer resource.
*
*
* @param getAuthorizerRequest
* Request to describe an existing Authorizer resource.
* @return A Java Future containing the result of the GetAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAuthorizer
*/
default CompletableFuture getAuthorizer(GetAuthorizerRequest getAuthorizerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Authorizer resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAuthorizerRequest.Builder} avoiding the need to
* create one manually via {@link GetAuthorizerRequest#builder()}
*
*
* @param getAuthorizerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAuthorizerRequest.Builder} to create a request.
* Request to describe an existing Authorizer resource.
* @return A Java Future containing the result of the GetAuthorizer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAuthorizer
*/
default CompletableFuture getAuthorizer(Consumer getAuthorizerRequest) {
return getAuthorizer(GetAuthorizerRequest.builder().applyMutation(getAuthorizerRequest).build());
}
/**
*
* Describe an existing Authorizers resource.
*
*
* @param getAuthorizersRequest
* Request to describe an existing Authorizers resource.
* @return A Java Future containing the result of the GetAuthorizers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAuthorizers
*/
default CompletableFuture getAuthorizers(GetAuthorizersRequest getAuthorizersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Authorizers resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetAuthorizersRequest.Builder} avoiding the need to
* create one manually via {@link GetAuthorizersRequest#builder()}
*
*
* @param getAuthorizersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetAuthorizersRequest.Builder} to create a
* request. Request to describe an existing Authorizers resource.
* @return A Java Future containing the result of the GetAuthorizers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetAuthorizers
*/
default CompletableFuture getAuthorizers(Consumer getAuthorizersRequest) {
return getAuthorizers(GetAuthorizersRequest.builder().applyMutation(getAuthorizersRequest).build());
}
/**
*
* Describe a BasePathMapping resource.
*
*
* @param getBasePathMappingRequest
* Request to describe a BasePathMapping resource.
* @return A Java Future containing the result of the GetBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMapping
*/
default CompletableFuture getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe a BasePathMapping resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingRequest#builder()}
*
*
* @param getBasePathMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingRequest.Builder} to create a
* request. Request to describe a BasePathMapping resource.
* @return A Java Future containing the result of the GetBasePathMapping operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMapping
*/
default CompletableFuture getBasePathMapping(
Consumer getBasePathMappingRequest) {
return getBasePathMapping(GetBasePathMappingRequest.builder().applyMutation(getBasePathMappingRequest).build());
}
/**
*
* Represents a collection of BasePathMapping resources.
*
*
* @param getBasePathMappingsRequest
* A request to get information about a collection of BasePathMapping resources.
* @return A Java Future containing the result of the GetBasePathMappings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMappings
*/
default CompletableFuture getBasePathMappings(
GetBasePathMappingsRequest getBasePathMappingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a collection of BasePathMapping resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingsRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingsRequest#builder()}
*
*
* @param getBasePathMappingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest.Builder} to create a
* request. A request to get information about a collection of BasePathMapping resources.
* @return A Java Future containing the result of the GetBasePathMappings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMappings
*/
default CompletableFuture getBasePathMappings(
Consumer getBasePathMappingsRequest) {
return getBasePathMappings(GetBasePathMappingsRequest.builder().applyMutation(getBasePathMappingsRequest).build());
}
/**
*
* This is a variant of
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation.
*
*
* @param getBasePathMappingsRequest
* A request to get information about a collection of BasePathMapping resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMappings
*/
default GetBasePathMappingsPublisher getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest) {
return new GetBasePathMappingsPublisher(this, getBasePathMappingsRequest);
}
/**
*
* This is a variant of
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetBasePathMappingsRequest.Builder} avoiding the
* need to create one manually via {@link GetBasePathMappingsRequest#builder()}
*
*
* @param getBasePathMappingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest.Builder} to create a
* request. A request to get information about a collection of BasePathMapping resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetBasePathMappings
*/
default GetBasePathMappingsPublisher getBasePathMappingsPaginator(
Consumer getBasePathMappingsRequest) {
return getBasePathMappingsPaginator(GetBasePathMappingsRequest.builder().applyMutation(getBasePathMappingsRequest)
.build());
}
/**
*
* Gets information about the current ClientCertificate resource.
*
*
* @param getClientCertificateRequest
* A request to get information about the current ClientCertificate resource.
* @return A Java Future containing the result of the GetClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificate
*/
default CompletableFuture getClientCertificate(
GetClientCertificateRequest getClientCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the current ClientCertificate resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificateRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificateRequest#builder()}
*
*
* @param getClientCertificateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificateRequest.Builder} to create a
* request. A request to get information about the current ClientCertificate resource.
* @return A Java Future containing the result of the GetClientCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificate
*/
default CompletableFuture getClientCertificate(
Consumer getClientCertificateRequest) {
return getClientCertificate(GetClientCertificateRequest.builder().applyMutation(getClientCertificateRequest).build());
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
* @param getClientCertificatesRequest
* A request to get information about a collection of ClientCertificate resources.
* @return A Java Future containing the result of the GetClientCertificates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default CompletableFuture getClientCertificates(
GetClientCertificatesRequest getClientCertificatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificatesRequest#builder()}
*
*
* @param getClientCertificatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest.Builder} to create a
* request. A request to get information about a collection of ClientCertificate resources.
* @return A Java Future containing the result of the GetClientCertificates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default CompletableFuture getClientCertificates(
Consumer getClientCertificatesRequest) {
return getClientCertificates(GetClientCertificatesRequest.builder().applyMutation(getClientCertificatesRequest).build());
}
/**
*
* Gets a collection of ClientCertificate resources.
*
*
* @return A Java Future containing the result of the GetClientCertificates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default CompletableFuture getClientCertificates() {
return getClientCertificates(GetClientCertificatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default GetClientCertificatesPublisher getClientCertificatesPaginator() {
return getClientCertificatesPaginator(GetClientCertificatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
* @param getClientCertificatesRequest
* A request to get information about a collection of ClientCertificate resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default GetClientCertificatesPublisher getClientCertificatesPaginator(
GetClientCertificatesRequest getClientCertificatesRequest) {
return new GetClientCertificatesPublisher(this, getClientCertificatesRequest);
}
/**
*
* This is a variant of
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetClientCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link GetClientCertificatesRequest#builder()}
*
*
* @param getClientCertificatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest.Builder} to create a
* request. A request to get information about a collection of ClientCertificate resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetClientCertificates
*/
default GetClientCertificatesPublisher getClientCertificatesPaginator(
Consumer getClientCertificatesRequest) {
return getClientCertificatesPaginator(GetClientCertificatesRequest.builder().applyMutation(getClientCertificatesRequest)
.build());
}
/**
*
* Gets information about a Deployment resource.
*
*
* @param getDeploymentRequest
* Requests API Gateway to get information about a Deployment resource.
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployment
*/
default CompletableFuture getDeployment(GetDeploymentRequest getDeploymentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Deployment resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentRequest#builder()}
*
*
* @param getDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest.Builder} to create a request.
* Requests API Gateway to get information about a Deployment resource.
* @return A Java Future containing the result of the GetDeployment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployment
*/
default CompletableFuture getDeployment(Consumer getDeploymentRequest) {
return getDeployment(GetDeploymentRequest.builder().applyMutation(getDeploymentRequest).build());
}
/**
*
* Gets information about a Deployments collection.
*
*
* @param getDeploymentsRequest
* Requests API Gateway to get information about a Deployments collection.
* @return A Java Future containing the result of the GetDeployments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployments
*/
default CompletableFuture getDeployments(GetDeploymentsRequest getDeploymentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Deployments collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentsRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentsRequest#builder()}
*
*
* @param getDeploymentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest.Builder} to create a
* request. Requests API Gateway to get information about a Deployments collection.
* @return A Java Future containing the result of the GetDeployments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployments
*/
default CompletableFuture getDeployments(Consumer getDeploymentsRequest) {
return getDeployments(GetDeploymentsRequest.builder().applyMutation(getDeploymentsRequest).build());
}
/**
*
* This is a variant of
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation.
*
*
* @param getDeploymentsRequest
* Requests API Gateway to get information about a Deployments collection.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployments
*/
default GetDeploymentsPublisher getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest) {
return new GetDeploymentsPublisher(this, getDeploymentsRequest);
}
/**
*
* This is a variant of
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeploymentsRequest.Builder} avoiding the need to
* create one manually via {@link GetDeploymentsRequest#builder()}
*
*
* @param getDeploymentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest.Builder} to create a
* request. Requests API Gateway to get information about a Deployments collection.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - ServiceUnavailableException The requested service is not available. For details see the accompanying
* error message. Retry after the specified time period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDeployments
*/
default GetDeploymentsPublisher getDeploymentsPaginator(Consumer getDeploymentsRequest) {
return getDeploymentsPaginator(GetDeploymentsRequest.builder().applyMutation(getDeploymentsRequest).build());
}
/**
*
* Gets a documentation part.
*
*
* @param getDocumentationPartRequest
* Gets a specified documentation part of a given API.
* @return A Java Future containing the result of the GetDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationPart
*/
default CompletableFuture getDocumentationPart(
GetDocumentationPartRequest getDocumentationPartRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a documentation part.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationPartRequest.Builder} avoiding the
* need to create one manually via {@link GetDocumentationPartRequest#builder()}
*
*
* @param getDocumentationPartRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationPartRequest.Builder} to create a
* request. Gets a specified documentation part of a given API.
* @return A Java Future containing the result of the GetDocumentationPart operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationPart
*/
default CompletableFuture getDocumentationPart(
Consumer getDocumentationPartRequest) {
return getDocumentationPart(GetDocumentationPartRequest.builder().applyMutation(getDocumentationPartRequest).build());
}
/**
*
* Gets documentation parts.
*
*
* @param getDocumentationPartsRequest
* Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
* entities (targets).
* @return A Java Future containing the result of the GetDocumentationParts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationParts
*/
default CompletableFuture getDocumentationParts(
GetDocumentationPartsRequest getDocumentationPartsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets documentation parts.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationPartsRequest.Builder} avoiding the
* need to create one manually via {@link GetDocumentationPartsRequest#builder()}
*
*
* @param getDocumentationPartsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest.Builder} to create a
* request. Gets the documentation parts of an API. The result may be filtered by the type, name, or path of
* API entities (targets).
* @return A Java Future containing the result of the GetDocumentationParts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationParts
*/
default CompletableFuture getDocumentationParts(
Consumer getDocumentationPartsRequest) {
return getDocumentationParts(GetDocumentationPartsRequest.builder().applyMutation(getDocumentationPartsRequest).build());
}
/**
*
* Gets a documentation version.
*
*
* @param getDocumentationVersionRequest
* Gets a documentation snapshot of an API.
* @return A Java Future containing the result of the GetDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationVersion
*/
default CompletableFuture getDocumentationVersion(
GetDocumentationVersionRequest getDocumentationVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a documentation version.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationVersionRequest.Builder} avoiding
* the need to create one manually via {@link GetDocumentationVersionRequest#builder()}
*
*
* @param getDocumentationVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionRequest.Builder} to create
* a request. Gets a documentation snapshot of an API.
* @return A Java Future containing the result of the GetDocumentationVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationVersion
*/
default CompletableFuture getDocumentationVersion(
Consumer getDocumentationVersionRequest) {
return getDocumentationVersion(GetDocumentationVersionRequest.builder().applyMutation(getDocumentationVersionRequest)
.build());
}
/**
*
* Gets documentation versions.
*
*
* @param getDocumentationVersionsRequest
* Gets the documentation versions of an API.
* @return A Java Future containing the result of the GetDocumentationVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationVersions
*/
default CompletableFuture getDocumentationVersions(
GetDocumentationVersionsRequest getDocumentationVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets documentation versions.
*
*
*
* This is a convenience which creates an instance of the {@link GetDocumentationVersionsRequest.Builder} avoiding
* the need to create one manually via {@link GetDocumentationVersionsRequest#builder()}
*
*
* @param getDocumentationVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDocumentationVersionsRequest.Builder} to create
* a request. Gets the documentation versions of an API.
* @return A Java Future containing the result of the GetDocumentationVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDocumentationVersions
*/
default CompletableFuture getDocumentationVersions(
Consumer getDocumentationVersionsRequest) {
return getDocumentationVersions(GetDocumentationVersionsRequest.builder().applyMutation(getDocumentationVersionsRequest)
.build());
}
/**
*
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*
*
* @param getDomainNameRequest
* Request to get the name of a DomainName resource.
* @return A Java Future containing the result of the GetDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainName
*/
default CompletableFuture getDomainName(GetDomainNameRequest getDomainNameRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNameRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNameRequest#builder()}
*
*
* @param getDomainNameRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNameRequest.Builder} to create a request.
* Request to get the name of a DomainName resource.
* @return A Java Future containing the result of the GetDomainName operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainName
*/
default CompletableFuture getDomainName(Consumer getDomainNameRequest) {
return getDomainName(GetDomainNameRequest.builder().applyMutation(getDomainNameRequest).build());
}
/**
*
* Represents a collection of DomainName resources.
*
*
* @param getDomainNamesRequest
* Request to describe a collection of DomainName resources.
* @return A Java Future containing the result of the GetDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default CompletableFuture getDomainNames(GetDomainNamesRequest getDomainNamesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a collection of DomainName resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNamesRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNamesRequest#builder()}
*
*
* @param getDomainNamesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest.Builder} to create a
* request. Request to describe a collection of DomainName resources.
* @return A Java Future containing the result of the GetDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default CompletableFuture getDomainNames(Consumer getDomainNamesRequest) {
return getDomainNames(GetDomainNamesRequest.builder().applyMutation(getDomainNamesRequest).build());
}
/**
*
* Represents a collection of DomainName resources.
*
*
* @return A Java Future containing the result of the GetDomainNames operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default CompletableFuture getDomainNames() {
return getDomainNames(GetDomainNamesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default GetDomainNamesPublisher getDomainNamesPaginator() {
return getDomainNamesPaginator(GetDomainNamesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
* @param getDomainNamesRequest
* Request to describe a collection of DomainName resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default GetDomainNamesPublisher getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest) {
return new GetDomainNamesPublisher(this, getDomainNamesRequest);
}
/**
*
* This is a variant of
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainNamesRequest.Builder} avoiding the need to
* create one manually via {@link GetDomainNamesRequest#builder()}
*
*
* @param getDomainNamesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest.Builder} to create a
* request. Request to describe a collection of DomainName resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetDomainNames
*/
default GetDomainNamesPublisher getDomainNamesPaginator(Consumer getDomainNamesRequest) {
return getDomainNamesPaginator(GetDomainNamesRequest.builder().applyMutation(getDomainNamesRequest).build());
}
/**
*
* Exports a deployed version of a RestApi in a specified format.
*
*
* @param getExportRequest
* Request a new export of a RestApi for a particular Stage.
* @return A Java Future containing the result of the GetExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetExport
*/
default CompletableFuture getExport(GetExportRequest getExportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Exports a deployed version of a RestApi in a specified format.
*
*
*
* This is a convenience which creates an instance of the {@link GetExportRequest.Builder} avoiding the need to
* create one manually via {@link GetExportRequest#builder()}
*
*
* @param getExportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetExportRequest.Builder} to create a request.
* Request a new export of a RestApi for a particular Stage.
* @return A Java Future containing the result of the GetExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetExport
*/
default CompletableFuture getExport(Consumer getExportRequest) {
return getExport(GetExportRequest.builder().applyMutation(getExportRequest).build());
}
/**
*
* Gets a GatewayResponse of a specified response type on the given RestApi.
*
*
* @param getGatewayResponseRequest
* Gets a GatewayResponse of a specified response type on the given RestApi.
* @return A Java Future containing the result of the GetGatewayResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetGatewayResponse
*/
default CompletableFuture getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a GatewayResponse of a specified response type on the given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetGatewayResponseRequest.Builder} avoiding the
* need to create one manually via {@link GetGatewayResponseRequest#builder()}
*
*
* @param getGatewayResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetGatewayResponseRequest.Builder} to create a
* request. Gets a GatewayResponse of a specified response type on the given RestApi.
* @return A Java Future containing the result of the GetGatewayResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetGatewayResponse
*/
default CompletableFuture getGatewayResponse(
Consumer getGatewayResponseRequest) {
return getGatewayResponse(GetGatewayResponseRequest.builder().applyMutation(getGatewayResponseRequest).build());
}
/**
*
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for
* gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the
* supported response types.
*
*
* @param getGatewayResponsesRequest
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
* definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
* collection for the supported response types.
* @return A Java Future containing the result of the GetGatewayResponses operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetGatewayResponses
*/
default CompletableFuture getGatewayResponses(
GetGatewayResponsesRequest getGatewayResponsesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for
* gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the
* supported response types.
*
*
*
* This is a convenience which creates an instance of the {@link GetGatewayResponsesRequest.Builder} avoiding the
* need to create one manually via {@link GetGatewayResponsesRequest#builder()}
*
*
* @param getGatewayResponsesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest.Builder} to create a
* request. Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
* definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
* collection for the supported response types.
* @return A Java Future containing the result of the GetGatewayResponses operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetGatewayResponses
*/
default CompletableFuture getGatewayResponses(
Consumer getGatewayResponsesRequest) {
return getGatewayResponses(GetGatewayResponsesRequest.builder().applyMutation(getGatewayResponsesRequest).build());
}
/**
*
* Get the integration settings.
*
*
* @param getIntegrationRequest
* Represents a request to get the integration configuration.
* @return A Java Future containing the result of the GetIntegration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetIntegration
*/
default CompletableFuture getIntegration(GetIntegrationRequest getIntegrationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Get the integration settings.
*
*
*
* This is a convenience which creates an instance of the {@link GetIntegrationRequest.Builder} avoiding the need to
* create one manually via {@link GetIntegrationRequest#builder()}
*
*
* @param getIntegrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetIntegrationRequest.Builder} to create a
* request. Represents a request to get the integration configuration.
* @return A Java Future containing the result of the GetIntegration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetIntegration
*/
default CompletableFuture getIntegration(Consumer getIntegrationRequest) {
return getIntegration(GetIntegrationRequest.builder().applyMutation(getIntegrationRequest).build());
}
/**
*
* Represents a get integration response.
*
*
* @param getIntegrationResponseRequest
* Represents a get integration response request.
* @return A Java Future containing the result of the GetIntegrationResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetIntegrationResponse
*/
default CompletableFuture getIntegrationResponse(
GetIntegrationResponseRequest getIntegrationResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Represents a get integration response.
*
*
*
* This is a convenience which creates an instance of the {@link GetIntegrationResponseRequest.Builder} avoiding the
* need to create one manually via {@link GetIntegrationResponseRequest#builder()}
*
*
* @param getIntegrationResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetIntegrationResponseRequest.Builder} to create a
* request. Represents a get integration response request.
* @return A Java Future containing the result of the GetIntegrationResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetIntegrationResponse
*/
default CompletableFuture getIntegrationResponse(
Consumer getIntegrationResponseRequest) {
return getIntegrationResponse(GetIntegrationResponseRequest.builder().applyMutation(getIntegrationResponseRequest)
.build());
}
/**
*
* Describe an existing Method resource.
*
*
* @param getMethodRequest
* Request to describe an existing Method resource.
* @return A Java Future containing the result of the GetMethod operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetMethod
*/
default CompletableFuture getMethod(GetMethodRequest getMethodRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe an existing Method resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetMethodRequest.Builder} avoiding the need to
* create one manually via {@link GetMethodRequest#builder()}
*
*
* @param getMethodRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetMethodRequest.Builder} to create a request.
* Request to describe an existing Method resource.
* @return A Java Future containing the result of the GetMethod operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetMethod
*/
default CompletableFuture getMethod(Consumer getMethodRequest) {
return getMethod(GetMethodRequest.builder().applyMutation(getMethodRequest).build());
}
/**
*
* Describes a MethodResponse resource.
*
*
* @param getMethodResponseRequest
* Request to describe a MethodResponse resource.
* @return A Java Future containing the result of the GetMethodResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetMethodResponse
*/
default CompletableFuture getMethodResponse(GetMethodResponseRequest getMethodResponseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a MethodResponse resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetMethodResponseRequest.Builder} avoiding the need
* to create one manually via {@link GetMethodResponseRequest#builder()}
*
*
* @param getMethodResponseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetMethodResponseRequest.Builder} to create a
* request. Request to describe a MethodResponse resource.
* @return A Java Future containing the result of the GetMethodResponse operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetMethodResponse
*/
default CompletableFuture getMethodResponse(
Consumer getMethodResponseRequest) {
return getMethodResponse(GetMethodResponseRequest.builder().applyMutation(getMethodResponseRequest).build());
}
/**
*
* Describes an existing model defined for a RestApi resource.
*
*
* @param getModelRequest
* Request to list information about a model in an existing RestApi resource.
* @return A Java Future containing the result of the GetModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModel
*/
default CompletableFuture getModel(GetModelRequest getModelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes an existing model defined for a RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelRequest.Builder} avoiding the need to
* create one manually via {@link GetModelRequest#builder()}
*
*
* @param getModelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelRequest.Builder} to create a request.
* Request to list information about a model in an existing RestApi resource.
* @return A Java Future containing the result of the GetModel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModel
*/
default CompletableFuture getModel(Consumer getModelRequest) {
return getModel(GetModelRequest.builder().applyMutation(getModelRequest).build());
}
/**
*
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*
*
* @param getModelTemplateRequest
* Request to generate a sample mapping template used to transform the payload.
* @return A Java Future containing the result of the GetModelTemplate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModelTemplate
*/
default CompletableFuture getModelTemplate(GetModelTemplateRequest getModelTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Generates a sample mapping template that can be used to transform a payload into the structure of a model.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelTemplateRequest.Builder} avoiding the need
* to create one manually via {@link GetModelTemplateRequest#builder()}
*
*
* @param getModelTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelTemplateRequest.Builder} to create a
* request. Request to generate a sample mapping template used to transform the payload.
* @return A Java Future containing the result of the GetModelTemplate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModelTemplate
*/
default CompletableFuture getModelTemplate(
Consumer getModelTemplateRequest) {
return getModelTemplate(GetModelTemplateRequest.builder().applyMutation(getModelTemplateRequest).build());
}
/**
*
* Describes existing Models defined for a RestApi resource.
*
*
* @param getModelsRequest
* Request to list existing Models defined for a RestApi resource.
* @return A Java Future containing the result of the GetModels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModels
*/
default CompletableFuture getModels(GetModelsRequest getModelsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes existing Models defined for a RestApi resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelsRequest.Builder} avoiding the need to
* create one manually via {@link GetModelsRequest#builder()}
*
*
* @param getModelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelsRequest.Builder} to create a request.
* Request to list existing Models defined for a RestApi resource.
* @return A Java Future containing the result of the GetModels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModels
*/
default CompletableFuture getModels(Consumer getModelsRequest) {
return getModels(GetModelsRequest.builder().applyMutation(getModelsRequest).build());
}
/**
*
* This is a variant of {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetModelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)} operation.
*
*
* @param getModelsRequest
* Request to list existing Models defined for a RestApi resource.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModels
*/
default GetModelsPublisher getModelsPaginator(GetModelsRequest getModelsRequest) {
return new GetModelsPublisher(this, getModelsRequest);
}
/**
*
* This is a variant of {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetModelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetModelsRequest.Builder} avoiding the need to
* create one manually via {@link GetModelsRequest#builder()}
*
*
* @param getModelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetModelsRequest.Builder} to create a request.
* Request to list existing Models defined for a RestApi resource.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetModels
*/
default GetModelsPublisher getModelsPaginator(Consumer getModelsRequest) {
return getModelsPaginator(GetModelsRequest.builder().applyMutation(getModelsRequest).build());
}
/**
*
* Gets a RequestValidator of a given RestApi.
*
*
* @param getRequestValidatorRequest
* Gets a RequestValidator of a given RestApi.
* @return A Java Future containing the result of the GetRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRequestValidator
*/
default CompletableFuture getRequestValidator(
GetRequestValidatorRequest getRequestValidatorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a RequestValidator of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetRequestValidatorRequest.Builder} avoiding the
* need to create one manually via {@link GetRequestValidatorRequest#builder()}
*
*
* @param getRequestValidatorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRequestValidatorRequest.Builder} to create a
* request. Gets a RequestValidator of a given RestApi.
* @return A Java Future containing the result of the GetRequestValidator operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRequestValidator
*/
default CompletableFuture getRequestValidator(
Consumer getRequestValidatorRequest) {
return getRequestValidator(GetRequestValidatorRequest.builder().applyMutation(getRequestValidatorRequest).build());
}
/**
*
* Gets the RequestValidators collection of a given RestApi.
*
*
* @param getRequestValidatorsRequest
* Gets the RequestValidators collection of a given RestApi.
* @return A Java Future containing the result of the GetRequestValidators operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRequestValidators
*/
default CompletableFuture getRequestValidators(
GetRequestValidatorsRequest getRequestValidatorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the RequestValidators collection of a given RestApi.
*
*
*
* This is a convenience which creates an instance of the {@link GetRequestValidatorsRequest.Builder} avoiding the
* need to create one manually via {@link GetRequestValidatorsRequest#builder()}
*
*
* @param getRequestValidatorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRequestValidatorsRequest.Builder} to create a
* request. Gets the RequestValidators collection of a given RestApi.
* @return A Java Future containing the result of the GetRequestValidators operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRequestValidators
*/
default CompletableFuture getRequestValidators(
Consumer getRequestValidatorsRequest) {
return getRequestValidators(GetRequestValidatorsRequest.builder().applyMutation(getRequestValidatorsRequest).build());
}
/**
*
* Lists information about a resource.
*
*
* @param getResourceRequest
* Request to list information about a resource.
* @return A Java Future containing the result of the GetResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResource
*/
default CompletableFuture getResource(GetResourceRequest getResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about a resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourceRequest.Builder} avoiding the need to
* create one manually via {@link GetResourceRequest#builder()}
*
*
* @param getResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourceRequest.Builder} to create a request.
* Request to list information about a resource.
* @return A Java Future containing the result of the GetResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResource
*/
default CompletableFuture getResource(Consumer getResourceRequest) {
return getResource(GetResourceRequest.builder().applyMutation(getResourceRequest).build());
}
/**
*
* Lists information about a collection of Resource resources.
*
*
* @param getResourcesRequest
* Request to list information about a collection of resources.
* @return A Java Future containing the result of the GetResources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResources
*/
default CompletableFuture getResources(GetResourcesRequest getResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about a collection of Resource resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourcesRequest.Builder} avoiding the need to
* create one manually via {@link GetResourcesRequest#builder()}
*
*
* @param getResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourcesRequest.Builder} to create a request.
* Request to list information about a collection of resources.
* @return A Java Future containing the result of the GetResources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResources
*/
default CompletableFuture getResources(Consumer getResourcesRequest) {
return getResources(GetResourcesRequest.builder().applyMutation(getResourcesRequest).build());
}
/**
*
* This is a variant of {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)} operation.
*
*
* @param getResourcesRequest
* Request to list information about a collection of resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResources
*/
default GetResourcesPublisher getResourcesPaginator(GetResourcesRequest getResourcesRequest) {
return new GetResourcesPublisher(this, getResourcesRequest);
}
/**
*
* This is a variant of {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetResourcesRequest.Builder} avoiding the need to
* create one manually via {@link GetResourcesRequest#builder()}
*
*
* @param getResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetResourcesRequest.Builder} to create a request.
* Request to list information about a collection of resources.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetResources
*/
default GetResourcesPublisher getResourcesPaginator(Consumer getResourcesRequest) {
return getResourcesPaginator(GetResourcesRequest.builder().applyMutation(getResourcesRequest).build());
}
/**
*
* Lists the RestApi resource in the collection.
*
*
* @param getRestApiRequest
* The GET request to list an existing RestApi defined for your collection.
* @return A Java Future containing the result of the GetRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApi
*/
default CompletableFuture getRestApi(GetRestApiRequest getRestApiRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the RestApi resource in the collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApiRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApiRequest#builder()}
*
*
* @param getRestApiRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApiRequest.Builder} to create a request.
* The GET request to list an existing RestApi defined for your collection.
* @return A Java Future containing the result of the GetRestApi operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApi
*/
default CompletableFuture getRestApi(Consumer getRestApiRequest) {
return getRestApi(GetRestApiRequest.builder().applyMutation(getRestApiRequest).build());
}
/**
*
* Lists the RestApis resources for your collection.
*
*
* @param getRestApisRequest
* The GET request to list existing RestApis defined for your collection.
* @return A Java Future containing the result of the GetRestApis operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default CompletableFuture getRestApis(GetRestApisRequest getRestApisRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the RestApis resources for your collection.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApisRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApisRequest#builder()}
*
*
* @param getRestApisRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApisRequest.Builder} to create a request.
* The GET request to list existing RestApis defined for your collection.
* @return A Java Future containing the result of the GetRestApis operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default CompletableFuture getRestApis(Consumer getRestApisRequest) {
return getRestApis(GetRestApisRequest.builder().applyMutation(getRestApisRequest).build());
}
/**
*
* Lists the RestApis resources for your collection.
*
*
* @return A Java Future containing the result of the GetRestApis operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default CompletableFuture getRestApis() {
return getRestApis(GetRestApisRequest.builder().build());
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default GetRestApisPublisher getRestApisPaginator() {
return getRestApisPaginator(GetRestApisRequest.builder().build());
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
* @param getRestApisRequest
* The GET request to list existing RestApis defined for your collection.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default GetRestApisPublisher getRestApisPaginator(GetRestApisRequest getRestApisRequest) {
return new GetRestApisPublisher(this, getRestApisRequest);
}
/**
*
* This is a variant of {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestApisRequest.Builder} avoiding the need to
* create one manually via {@link GetRestApisRequest#builder()}
*
*
* @param getRestApisRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetRestApisRequest.Builder} to create a request.
* The GET request to list existing RestApis defined for your collection.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetRestApis
*/
default GetRestApisPublisher getRestApisPaginator(Consumer getRestApisRequest) {
return getRestApisPaginator(GetRestApisRequest.builder().applyMutation(getRestApisRequest).build());
}
/**
*
* Generates a client SDK for a RestApi and Stage.
*
*
* @param getSdkRequest
* Request a new generated client SDK for a RestApi and Stage.
* @return A Java Future containing the result of the GetSdk operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdk
*/
default CompletableFuture getSdk(GetSdkRequest getSdkRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Generates a client SDK for a RestApi and Stage.
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkRequest.Builder} avoiding the need to create
* one manually via {@link GetSdkRequest#builder()}
*
*
* @param getSdkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkRequest.Builder} to create a request.
* Request a new generated client SDK for a RestApi and Stage.
* @return A Java Future containing the result of the GetSdk operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdk
*/
default CompletableFuture getSdk(Consumer getSdkRequest) {
return getSdk(GetSdkRequest.builder().applyMutation(getSdkRequest).build());
}
/**
*
* Gets an SDK type.
*
*
* @param getSdkTypeRequest
* Get an SdkType instance.
* @return A Java Future containing the result of the GetSdkType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdkType
*/
default CompletableFuture getSdkType(GetSdkTypeRequest getSdkTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets an SDK type.
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkTypeRequest.Builder} avoiding the need to
* create one manually via {@link GetSdkTypeRequest#builder()}
*
*
* @param getSdkTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkTypeRequest.Builder} to create a request.
* Get an SdkType instance.
* @return A Java Future containing the result of the GetSdkType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdkType
*/
default CompletableFuture getSdkType(Consumer getSdkTypeRequest) {
return getSdkType(GetSdkTypeRequest.builder().applyMutation(getSdkTypeRequest).build());
}
/**
*
* Gets SDK types
*
*
* @param getSdkTypesRequest
* Get the SdkTypes collection.
* @return A Java Future containing the result of the GetSdkTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdkTypes
*/
default CompletableFuture getSdkTypes(GetSdkTypesRequest getSdkTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets SDK types
*
*
*
* This is a convenience which creates an instance of the {@link GetSdkTypesRequest.Builder} avoiding the need to
* create one manually via {@link GetSdkTypesRequest#builder()}
*
*
* @param getSdkTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetSdkTypesRequest.Builder} to create a request.
* Get the SdkTypes collection.
* @return A Java Future containing the result of the GetSdkTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdkTypes
*/
default CompletableFuture getSdkTypes(Consumer getSdkTypesRequest) {
return getSdkTypes(GetSdkTypesRequest.builder().applyMutation(getSdkTypesRequest).build());
}
/**
*
* Gets SDK types
*
*
* @return A Java Future containing the result of the GetSdkTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetSdkTypes
*/
default CompletableFuture getSdkTypes() {
return getSdkTypes(GetSdkTypesRequest.builder().build());
}
/**
*
* Gets information about a Stage resource.
*
*
* @param getStageRequest
* Requests API Gateway to get information about a Stage resource.
* @return A Java Future containing the result of the GetStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetStage
*/
default CompletableFuture getStage(GetStageRequest getStageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Stage resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetStageRequest.Builder} avoiding the need to
* create one manually via {@link GetStageRequest#builder()}
*
*
* @param getStageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetStageRequest.Builder} to create a request.
* Requests API Gateway to get information about a Stage resource.
* @return A Java Future containing the result of the GetStage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetStage
*/
default CompletableFuture getStage(Consumer getStageRequest) {
return getStage(GetStageRequest.builder().applyMutation(getStageRequest).build());
}
/**
*
* Gets information about one or more Stage resources.
*
*
* @param getStagesRequest
* Requests API Gateway to get information about one or more Stage resources.
* @return A Java Future containing the result of the GetStages operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetStages
*/
default CompletableFuture getStages(GetStagesRequest getStagesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about one or more Stage resources.
*
*
*
* This is a convenience which creates an instance of the {@link GetStagesRequest.Builder} avoiding the need to
* create one manually via {@link GetStagesRequest#builder()}
*
*
* @param getStagesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetStagesRequest.Builder} to create a request.
* Requests API Gateway to get information about one or more Stage resources.
* @return A Java Future containing the result of the GetStages operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - ConflictException The request configuration has conflicts. For details, see the accompanying error
* message.
* - LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetStages
*/
default CompletableFuture getStages(Consumer getStagesRequest) {
return getStages(GetStagesRequest.builder().applyMutation(getStagesRequest).build());
}
/**
*
* Gets the Tags collection for a given resource.
*
*
* @param getTagsRequest
* Gets the Tags collection for a given resource.
* @return A Java Future containing the result of the GetTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetTags
*/
default CompletableFuture getTags(GetTagsRequest getTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the Tags collection for a given resource.
*
*
*
* This is a convenience which creates an instance of the {@link GetTagsRequest.Builder} avoiding the need to create
* one manually via {@link GetTagsRequest#builder()}
*
*
* @param getTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.GetTagsRequest.Builder} to create a request. Gets
* the Tags collection for a given resource.
* @return A Java Future containing the result of the GetTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The submitted request is not valid, for example, the input is incomplete or
* incorrect. See the accompanying error message for details.
* - NotFoundException The requested resource is not found. Make sure that the request URI is correct.
* - UnauthorizedException The request is denied because the caller has insufficient permissions.
* - TooManyRequestsException The request has reached its throttling limit. Retry after the specified time
* period.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ApiGatewayAsyncClient.GetTags
*/
default CompletableFuture getTags(Consumer getTagsRequest) {
return getTags(GetTagsRequest.builder().applyMutation(getTagsRequest).build());
}
/**
*