@Generated(value="software.amazon.awssdk:codegen") public interface ApiGatewayAsyncClient extends SdkClient
builder() method.
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 AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static ApiGatewayAsyncClient create()
ApiGatewayAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ApiGatewayAsyncClientBuilder builder()
ApiGatewayAsyncClient.default CompletableFuture<CreateApiKeyResponse> createApiKey(CreateApiKeyRequest createApiKeyRequest)
createApiKeyRequest - Request to create an ApiKey resource.default CompletableFuture<CreateApiKeyResponse> createApiKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest)
Create an ApiKey resource.
This is a convenience which creates an instance of the CreateApiKeyRequest.Builder avoiding the need to
create one manually via CreateApiKeyRequest.builder()
createApiKeyRequest - A Consumer that will call methods on CreateApiKeyRequest.Builder to create a request.
Request to create an ApiKey resource.default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
This is a convenience which creates an instance of the CreateAuthorizerRequest.Builder avoiding the need
to create one manually via CreateAuthorizerRequest.builder()
createAuthorizerRequest - A Consumer that will call methods on CreateAuthorizerRequest.Builder to create a request.
Request to add a new Authorizer to an existing RestApi resource.default CompletableFuture<CreateBasePathMappingResponse> createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
createBasePathMappingRequest - Requests API Gateway to create a new BasePathMapping resource.default CompletableFuture<CreateBasePathMappingResponse> createBasePathMapping(Consumer<CreateBasePathMappingRequest.Builder> createBasePathMappingRequest)
Creates a new BasePathMapping resource.
This is a convenience which creates an instance of the CreateBasePathMappingRequest.Builder avoiding the
need to create one manually via CreateBasePathMappingRequest.builder()
createBasePathMappingRequest - A Consumer that will call methods on CreateBasePathMappingRequest.Builder to create a
request. Requests API Gateway to create a new BasePathMapping resource.default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeploymentRequest - Requests API Gateway to create a Deployment resource.default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
This is a convenience which creates an instance of the CreateDeploymentRequest.Builder avoiding the need
to create one manually via CreateDeploymentRequest.builder()
createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.
Requests API Gateway to create a Deployment resource.default CompletableFuture<CreateDocumentationPartResponse> createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
createDocumentationPartRequest - Creates a new documentation part of a given API.default CompletableFuture<CreateDocumentationPartResponse> createDocumentationPart(Consumer<CreateDocumentationPartRequest.Builder> createDocumentationPartRequest)
This is a convenience which creates an instance of the CreateDocumentationPartRequest.Builder avoiding
the need to create one manually via CreateDocumentationPartRequest.builder()
createDocumentationPartRequest - A Consumer that will call methods on CreateDocumentationPartRequest.Builder to create a
request. Creates a new documentation part of a given API.default CompletableFuture<CreateDocumentationVersionResponse> createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
createDocumentationVersionRequest - Creates a new documentation version of a given API.default CompletableFuture<CreateDocumentationVersionResponse> createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest)
This is a convenience which creates an instance of the CreateDocumentationVersionRequest.Builder avoiding
the need to create one manually via CreateDocumentationVersionRequest.builder()
createDocumentationVersionRequest - A Consumer that will call methods on CreateDocumentationVersionRequest.Builder to create a
request. Creates a new documentation version of a given API.default CompletableFuture<CreateDomainNameResponse> createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
createDomainNameRequest - A request to create a new domain name.default CompletableFuture<CreateDomainNameResponse> createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest)
Creates a new domain name.
This is a convenience which creates an instance of the CreateDomainNameRequest.Builder avoiding the need
to create one manually via CreateDomainNameRequest.builder()
createDomainNameRequest - A Consumer that will call methods on CreateDomainNameRequest.Builder to create a request.
A request to create a new domain name.default CompletableFuture<CreateModelResponse> createModel(CreateModelRequest createModelRequest)
createModelRequest - Request to add a new Model to an existing RestApi resource.default CompletableFuture<CreateModelResponse> createModel(Consumer<CreateModelRequest.Builder> createModelRequest)
Adds a new Model resource to an existing RestApi resource.
This is a convenience which creates an instance of the CreateModelRequest.Builder avoiding the need to
create one manually via CreateModelRequest.builder()
createModelRequest - A Consumer that will call methods on CreateModelRequest.Builder to create a request.
Request to add a new Model to an existing RestApi resource.default CompletableFuture<CreateRequestValidatorResponse> createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
Creates a ReqeustValidator of a given RestApi.
createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.default CompletableFuture<CreateRequestValidatorResponse> createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest)
Creates a ReqeustValidator of a given RestApi.
This is a convenience which creates an instance of the CreateRequestValidatorRequest.Builder avoiding the
need to create one manually via CreateRequestValidatorRequest.builder()
createRequestValidatorRequest - A Consumer that will call methods on CreateRequestValidatorRequest.Builder to create a
request. Creates a RequestValidator of a given RestApi.default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
createResourceRequest - Requests API Gateway to create a Resource resource.default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a Resource resource.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.
Requests API Gateway to create a Resource resource.default CompletableFuture<CreateRestApiResponse> createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
createRestApiRequest - The POST Request to add a new RestApi resource to your collection.default CompletableFuture<CreateRestApiResponse> createRestApi(Consumer<CreateRestApiRequest.Builder> createRestApiRequest)
Creates a new RestApi resource.
This is a convenience which creates an instance of the CreateRestApiRequest.Builder avoiding the need to
create one manually via CreateRestApiRequest.builder()
createRestApiRequest - A Consumer that will call methods on CreateRestApiRequest.Builder to create a request. The
POST Request to add a new RestApi resource to your collection.default CompletableFuture<CreateStageResponse> createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStageRequest - Requests API Gateway to create a Stage resource.default CompletableFuture<CreateStageResponse> createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
This is a convenience which creates an instance of the CreateStageRequest.Builder avoiding the need to
create one manually via CreateStageRequest.builder()
createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request.
Requests API Gateway to create a Stage resource.default CompletableFuture<CreateUsagePlanResponse> createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
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.default CompletableFuture<CreateUsagePlanResponse> createUsagePlan(Consumer<CreateUsagePlanRequest.Builder> createUsagePlanRequest)
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 CreateUsagePlanRequest.Builder avoiding the need
to create one manually via CreateUsagePlanRequest.builder()
createUsagePlanRequest - A Consumer that will call methods on 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.default CompletableFuture<CreateUsagePlanKeyResponse> createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.default CompletableFuture<CreateUsagePlanKeyResponse> createUsagePlanKey(Consumer<CreateUsagePlanKeyRequest.Builder> createUsagePlanKeyRequest)
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 CreateUsagePlanKeyRequest.Builder avoiding the
need to create one manually via CreateUsagePlanKeyRequest.builder()
createUsagePlanKeyRequest - A Consumer that will call methods on 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.default CompletableFuture<CreateVpcLinkResponse> createVpcLink(CreateVpcLinkRequest 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.
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.default CompletableFuture<CreateVpcLinkResponse> createVpcLink(Consumer<CreateVpcLinkRequest.Builder> 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.
This is a convenience which creates an instance of the CreateVpcLinkRequest.Builder avoiding the need to
create one manually via CreateVpcLinkRequest.builder()
createVpcLinkRequest - A Consumer that will call methods on 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.default CompletableFuture<DeleteApiKeyResponse> deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
deleteApiKeyRequest - A request to delete the ApiKey resource.default CompletableFuture<DeleteApiKeyResponse> deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest)
Deletes the ApiKey resource.
This is a convenience which creates an instance of the DeleteApiKeyRequest.Builder avoiding the need to
create one manually via DeleteApiKeyRequest.builder()
deleteApiKeyRequest - A Consumer that will call methods on DeleteApiKeyRequest.Builder to create a request. A
request to delete the ApiKey resource.default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
deleteAuthorizerRequest - Request to delete an existing Authorizer resource.default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
This is a convenience which creates an instance of the DeleteAuthorizerRequest.Builder avoiding the need
to create one manually via DeleteAuthorizerRequest.builder()
deleteAuthorizerRequest - A Consumer that will call methods on DeleteAuthorizerRequest.Builder to create a request.
Request to delete an existing Authorizer resource.default CompletableFuture<DeleteBasePathMappingResponse> deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.default CompletableFuture<DeleteBasePathMappingResponse> deleteBasePathMapping(Consumer<DeleteBasePathMappingRequest.Builder> deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
This is a convenience which creates an instance of the DeleteBasePathMappingRequest.Builder avoiding the
need to create one manually via DeleteBasePathMappingRequest.builder()
deleteBasePathMappingRequest - A Consumer that will call methods on DeleteBasePathMappingRequest.Builder to create a
request. A request to delete the BasePathMapping resource.default CompletableFuture<DeleteClientCertificateResponse> deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
deleteClientCertificateRequest - A request to delete the ClientCertificate resource.default CompletableFuture<DeleteClientCertificateResponse> deleteClientCertificate(Consumer<DeleteClientCertificateRequest.Builder> deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
This is a convenience which creates an instance of the DeleteClientCertificateRequest.Builder avoiding
the need to create one manually via DeleteClientCertificateRequest.builder()
deleteClientCertificateRequest - A Consumer that will call methods on DeleteClientCertificateRequest.Builder to create a
request. A request to delete the ClientCertificate resource.default CompletableFuture<DeleteDeploymentResponse> deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeploymentRequest - Requests API Gateway to delete a Deployment resource.default CompletableFuture<DeleteDeploymentResponse> deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)
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 DeleteDeploymentRequest.Builder avoiding the need
to create one manually via DeleteDeploymentRequest.builder()
deleteDeploymentRequest - A Consumer that will call methods on DeleteDeploymentRequest.Builder to create a request.
Requests API Gateway to delete a Deployment resource.default CompletableFuture<DeleteDocumentationPartResponse> deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
deleteDocumentationPartRequest - Deletes an existing documentation part of an API.default CompletableFuture<DeleteDocumentationPartResponse> deleteDocumentationPart(Consumer<DeleteDocumentationPartRequest.Builder> deleteDocumentationPartRequest)
This is a convenience which creates an instance of the DeleteDocumentationPartRequest.Builder avoiding
the need to create one manually via DeleteDocumentationPartRequest.builder()
deleteDocumentationPartRequest - A Consumer that will call methods on DeleteDocumentationPartRequest.Builder to create a
request. Deletes an existing documentation part of an API.default CompletableFuture<DeleteDocumentationVersionResponse> deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.default CompletableFuture<DeleteDocumentationVersionResponse> deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest)
This is a convenience which creates an instance of the DeleteDocumentationVersionRequest.Builder avoiding
the need to create one manually via DeleteDocumentationVersionRequest.builder()
deleteDocumentationVersionRequest - A Consumer that will call methods on DeleteDocumentationVersionRequest.Builder to create a
request. Deletes an existing documentation version of an API.default CompletableFuture<DeleteDomainNameResponse> deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
deleteDomainNameRequest - A request to delete the DomainName resource.default CompletableFuture<DeleteDomainNameResponse> deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest)
Deletes the DomainName resource.
This is a convenience which creates an instance of the DeleteDomainNameRequest.Builder avoiding the need
to create one manually via DeleteDomainNameRequest.builder()
deleteDomainNameRequest - A Consumer that will call methods on DeleteDomainNameRequest.Builder to create a request.
A request to delete the DomainName resource.default CompletableFuture<DeleteGatewayResponseResponse> deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
deleteGatewayResponseRequest - Clears any customization of a GatewayResponse of a specified response type on the given
RestApi and resets it with the default settings.default CompletableFuture<DeleteGatewayResponseResponse> deleteGatewayResponse(Consumer<DeleteGatewayResponseRequest.Builder> deleteGatewayResponseRequest)
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 DeleteGatewayResponseRequest.Builder avoiding the
need to create one manually via DeleteGatewayResponseRequest.builder()
deleteGatewayResponseRequest - A Consumer that will call methods on 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.default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
deleteIntegrationRequest - Represents a delete integration request.default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)
Represents a delete integration.
This is a convenience which creates an instance of the DeleteIntegrationRequest.Builder avoiding the need
to create one manually via DeleteIntegrationRequest.builder()
deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request.
Represents a delete integration request.default CompletableFuture<DeleteIntegrationResponseResponse> deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
deleteIntegrationResponseRequest - Represents a delete integration response request.default CompletableFuture<DeleteIntegrationResponseResponse> deleteIntegrationResponse(Consumer<DeleteIntegrationResponseRequest.Builder> deleteIntegrationResponseRequest)
Represents a delete integration response.
This is a convenience which creates an instance of the DeleteIntegrationResponseRequest.Builder avoiding
the need to create one manually via DeleteIntegrationResponseRequest.builder()
deleteIntegrationResponseRequest - A Consumer that will call methods on DeleteIntegrationResponseRequest.Builder to create a
request. Represents a delete integration response request.default CompletableFuture<DeleteMethodResponse> deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
deleteMethodRequest - Request to delete an existing Method resource.default CompletableFuture<DeleteMethodResponse> deleteMethod(Consumer<DeleteMethodRequest.Builder> deleteMethodRequest)
Deletes an existing Method resource.
This is a convenience which creates an instance of the DeleteMethodRequest.Builder avoiding the need to
create one manually via DeleteMethodRequest.builder()
deleteMethodRequest - A Consumer that will call methods on DeleteMethodRequest.Builder to create a request.
Request to delete an existing Method resource.default CompletableFuture<DeleteMethodResponseResponse> deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.default CompletableFuture<DeleteMethodResponseResponse> deleteMethodResponse(Consumer<DeleteMethodResponseRequest.Builder> deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
This is a convenience which creates an instance of the DeleteMethodResponseRequest.Builder avoiding the
need to create one manually via DeleteMethodResponseRequest.builder()
deleteMethodResponseRequest - A Consumer that will call methods on DeleteMethodResponseRequest.Builder to create a
request. A request to delete an existing MethodResponse resource.default CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
deleteModelRequest - Request to delete an existing model in an existing RestApi resource.default CompletableFuture<DeleteModelResponse> deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)
Deletes a model.
This is a convenience which creates an instance of the DeleteModelRequest.Builder avoiding the need to
create one manually via DeleteModelRequest.builder()
deleteModelRequest - A Consumer that will call methods on DeleteModelRequest.Builder to create a request.
Request to delete an existing model in an existing RestApi resource.default CompletableFuture<DeleteRequestValidatorResponse> deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.default CompletableFuture<DeleteRequestValidatorResponse> deleteRequestValidator(Consumer<DeleteRequestValidatorRequest.Builder> deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the DeleteRequestValidatorRequest.Builder avoiding the
need to create one manually via DeleteRequestValidatorRequest.builder()
deleteRequestValidatorRequest - A Consumer that will call methods on DeleteRequestValidatorRequest.Builder to create a
request. Deletes a specified RequestValidator of a given RestApi.default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
deleteResourceRequest - Request to delete a Resource.default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes a Resource resource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.
Request to delete a Resource.default CompletableFuture<DeleteRestApiResponse> deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
deleteRestApiRequest - Request to delete the specified API from your collection.default CompletableFuture<DeleteRestApiResponse> deleteRestApi(Consumer<DeleteRestApiRequest.Builder> deleteRestApiRequest)
Deletes the specified API.
This is a convenience which creates an instance of the DeleteRestApiRequest.Builder avoiding the need to
create one manually via DeleteRestApiRequest.builder()
deleteRestApiRequest - A Consumer that will call methods on DeleteRestApiRequest.Builder to create a request.
Request to delete the specified API from your collection.default CompletableFuture<DeleteStageResponse> deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
deleteStageRequest - Requests API Gateway to delete a Stage resource.default CompletableFuture<DeleteStageResponse> deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Deletes a Stage resource.
This is a convenience which creates an instance of the DeleteStageRequest.Builder avoiding the need to
create one manually via DeleteStageRequest.builder()
deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request.
Requests API Gateway to delete a Stage resource.default CompletableFuture<DeleteUsagePlanResponse> deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
deleteUsagePlanRequest - The DELETE request to delete a usage plan of a given plan Id.default CompletableFuture<DeleteUsagePlanResponse> deleteUsagePlan(Consumer<DeleteUsagePlanRequest.Builder> deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
This is a convenience which creates an instance of the DeleteUsagePlanRequest.Builder avoiding the need
to create one manually via DeleteUsagePlanRequest.builder()
deleteUsagePlanRequest - A Consumer that will call methods on DeleteUsagePlanRequest.Builder to create a request.
The DELETE request to delete a usage plan of a given plan Id.default CompletableFuture<DeleteUsagePlanKeyResponse> deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.default CompletableFuture<DeleteUsagePlanKeyResponse> deleteUsagePlanKey(Consumer<DeleteUsagePlanKeyRequest.Builder> deleteUsagePlanKeyRequest)
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 DeleteUsagePlanKeyRequest.Builder avoiding the
need to create one manually via DeleteUsagePlanKeyRequest.builder()
deleteUsagePlanKeyRequest - A Consumer that will call methods on 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.default CompletableFuture<DeleteVpcLinkResponse> deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
deleteVpcLinkRequest - Deletes an existing VpcLink of a specified identifier.default CompletableFuture<DeleteVpcLinkResponse> deleteVpcLink(Consumer<DeleteVpcLinkRequest.Builder> deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
This is a convenience which creates an instance of the DeleteVpcLinkRequest.Builder avoiding the need to
create one manually via DeleteVpcLinkRequest.builder()
deleteVpcLinkRequest - A Consumer that will call methods on DeleteVpcLinkRequest.Builder to create a request.
Deletes an existing VpcLink of a specified identifier.default CompletableFuture<FlushStageAuthorizersCacheResponse> flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.default CompletableFuture<FlushStageAuthorizersCacheResponse> flushStageAuthorizersCache(Consumer<FlushStageAuthorizersCacheRequest.Builder> flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
This is a convenience which creates an instance of the FlushStageAuthorizersCacheRequest.Builder avoiding
the need to create one manually via FlushStageAuthorizersCacheRequest.builder()
flushStageAuthorizersCacheRequest - A Consumer that will call methods on FlushStageAuthorizersCacheRequest.Builder to create a
request. Request to flush authorizer cache entries on a specified stage.default CompletableFuture<FlushStageCacheResponse> flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
flushStageCacheRequest - Requests API Gateway to flush a stage's cache.default CompletableFuture<FlushStageCacheResponse> flushStageCache(Consumer<FlushStageCacheRequest.Builder> flushStageCacheRequest)
Flushes a stage's cache.
This is a convenience which creates an instance of the FlushStageCacheRequest.Builder avoiding the need
to create one manually via FlushStageCacheRequest.builder()
flushStageCacheRequest - A Consumer that will call methods on FlushStageCacheRequest.Builder to create a request.
Requests API Gateway to flush a stage's cache.default CompletableFuture<GenerateClientCertificateResponse> generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
generateClientCertificateRequest - A request to generate a ClientCertificate resource.default CompletableFuture<GenerateClientCertificateResponse> generateClientCertificate(Consumer<GenerateClientCertificateRequest.Builder> generateClientCertificateRequest)
Generates a ClientCertificate resource.
This is a convenience which creates an instance of the GenerateClientCertificateRequest.Builder avoiding
the need to create one manually via GenerateClientCertificateRequest.builder()
generateClientCertificateRequest - A Consumer that will call methods on GenerateClientCertificateRequest.Builder to create a
request. A request to generate a ClientCertificate resource.default CompletableFuture<GetAccountResponse> getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
getAccountRequest - Requests API Gateway to get information about the current Account resource.default CompletableFuture<GetAccountResponse> getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)
Gets information about the current Account resource.
This is a convenience which creates an instance of the GetAccountRequest.Builder avoiding the need to
create one manually via GetAccountRequest.builder()
getAccountRequest - A Consumer that will call methods on GetAccountRequest.Builder to create a request.
Requests API Gateway to get information about the current Account resource.default CompletableFuture<GetAccountResponse> getAccount()
Gets information about the current Account resource.
default CompletableFuture<GetApiKeyResponse> getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
getApiKeyRequest - A request to get information about the current ApiKey resource.default CompletableFuture<GetApiKeyResponse> getApiKey(Consumer<GetApiKeyRequest.Builder> getApiKeyRequest)
Gets information about the current ApiKey resource.
This is a convenience which creates an instance of the GetApiKeyRequest.Builder avoiding the need to
create one manually via GetApiKeyRequest.builder()
getApiKeyRequest - A Consumer that will call methods on GetApiKeyRequest.Builder to create a request. A
request to get information about the current ApiKey resource.default CompletableFuture<GetApiKeysResponse> getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
getApiKeysRequest - A request to get information about the current ApiKeys resource.default CompletableFuture<GetApiKeysResponse> getApiKeys(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
Gets information about the current ApiKeys resource.
This is a convenience which creates an instance of the GetApiKeysRequest.Builder avoiding the need to
create one manually via GetApiKeysRequest.builder()
getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A
request to get information about the current ApiKeys resource.default CompletableFuture<GetApiKeysResponse> getApiKeys()
Gets information about the current ApiKeys resource.
default GetApiKeysPublisher getApiKeysPaginator()
Gets information about the current ApiKeys resource.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
default GetApiKeysPublisher getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
getApiKeysRequest - A request to get information about the current ApiKeys resource.default GetApiKeysPublisher getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
Gets information about the current ApiKeys resource.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
This is a convenience which creates an instance of the GetApiKeysRequest.Builder avoiding the need to
create one manually via GetApiKeysRequest.builder()
getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A
request to get information about the current ApiKeys resource.default CompletableFuture<GetAuthorizerResponse> getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
getAuthorizerRequest - Request to describe an existing Authorizer resource.default CompletableFuture<GetAuthorizerResponse> getAuthorizer(Consumer<GetAuthorizerRequest.Builder> getAuthorizerRequest)
Describe an existing Authorizer resource.
This is a convenience which creates an instance of the GetAuthorizerRequest.Builder avoiding the need to
create one manually via GetAuthorizerRequest.builder()
getAuthorizerRequest - A Consumer that will call methods on GetAuthorizerRequest.Builder to create a request.
Request to describe an existing Authorizer resource.default CompletableFuture<GetAuthorizersResponse> getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
getAuthorizersRequest - Request to describe an existing Authorizers resource.default CompletableFuture<GetAuthorizersResponse> getAuthorizers(Consumer<GetAuthorizersRequest.Builder> getAuthorizersRequest)
Describe an existing Authorizers resource.
This is a convenience which creates an instance of the GetAuthorizersRequest.Builder avoiding the need to
create one manually via GetAuthorizersRequest.builder()
getAuthorizersRequest - A Consumer that will call methods on GetAuthorizersRequest.Builder to create a request.
Request to describe an existing Authorizers resource.default CompletableFuture<GetBasePathMappingResponse> getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
getBasePathMappingRequest - Request to describe a BasePathMapping resource.default CompletableFuture<GetBasePathMappingResponse> getBasePathMapping(Consumer<GetBasePathMappingRequest.Builder> getBasePathMappingRequest)
Describe a BasePathMapping resource.
This is a convenience which creates an instance of the GetBasePathMappingRequest.Builder avoiding the
need to create one manually via GetBasePathMappingRequest.builder()
getBasePathMappingRequest - A Consumer that will call methods on GetBasePathMappingRequest.Builder to create a
request. Request to describe a BasePathMapping resource.default CompletableFuture<GetBasePathMappingsResponse> getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.default CompletableFuture<GetBasePathMappingsResponse> getBasePathMappings(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
This is a convenience which creates an instance of the GetBasePathMappingsRequest.Builder avoiding the
need to create one manually via GetBasePathMappingsRequest.builder()
getBasePathMappingsRequest - A Consumer that will call methods on GetBasePathMappingsRequest.Builder to create a
request. A request to get information about a collection of BasePathMapping resources.default GetBasePathMappingsPublisher getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation.
getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.default GetBasePathMappingsPublisher getBasePathMappingsPaginator(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation.
This is a convenience which creates an instance of the GetBasePathMappingsRequest.Builder avoiding the
need to create one manually via GetBasePathMappingsRequest.builder()
getBasePathMappingsRequest - A Consumer that will call methods on GetBasePathMappingsRequest.Builder to create a
request. A request to get information about a collection of BasePathMapping resources.default CompletableFuture<GetClientCertificateResponse> getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
getClientCertificateRequest - A request to get information about the current ClientCertificate resource.default CompletableFuture<GetClientCertificateResponse> getClientCertificate(Consumer<GetClientCertificateRequest.Builder> getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
This is a convenience which creates an instance of the GetClientCertificateRequest.Builder avoiding the
need to create one manually via GetClientCertificateRequest.builder()
getClientCertificateRequest - A Consumer that will call methods on GetClientCertificateRequest.Builder to create a
request. A request to get information about the current ClientCertificate resource.default CompletableFuture<GetClientCertificatesResponse> getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.default CompletableFuture<GetClientCertificatesResponse> getClientCertificates(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
This is a convenience which creates an instance of the GetClientCertificatesRequest.Builder avoiding the
need to create one manually via GetClientCertificatesRequest.builder()
getClientCertificatesRequest - A Consumer that will call methods on GetClientCertificatesRequest.Builder to create a
request. A request to get information about a collection of ClientCertificate resources.default CompletableFuture<GetClientCertificatesResponse> getClientCertificates()
Gets a collection of ClientCertificate resources.
default GetClientCertificatesPublisher getClientCertificatesPaginator()
Gets a collection of ClientCertificate resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
default GetClientCertificatesPublisher getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.default GetClientCertificatesPublisher getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
This is a convenience which creates an instance of the GetClientCertificatesRequest.Builder avoiding the
need to create one manually via GetClientCertificatesRequest.builder()
getClientCertificatesRequest - A Consumer that will call methods on GetClientCertificatesRequest.Builder to create a
request. A request to get information about a collection of ClientCertificate resources.default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
getDeploymentRequest - Requests API Gateway to get information about a Deployment resource.default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
Gets information about a Deployment resource.
This is a convenience which creates an instance of the GetDeploymentRequest.Builder avoiding the need to
create one manually via GetDeploymentRequest.builder()
getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request.
Requests API Gateway to get information about a Deployment resource.default CompletableFuture<GetDeploymentsResponse> getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.default CompletableFuture<GetDeploymentsResponse> getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)
Gets information about a Deployments collection.
This is a convenience which creates an instance of the GetDeploymentsRequest.Builder avoiding the need to
create one manually via GetDeploymentsRequest.builder()
getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request.
Requests API Gateway to get information about a Deployments collection.default GetDeploymentsPublisher getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.
getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.default GetDeploymentsPublisher getDeploymentsPaginator(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)
Gets information about a Deployments collection.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.
This is a convenience which creates an instance of the GetDeploymentsRequest.Builder avoiding the need to
create one manually via GetDeploymentsRequest.builder()
getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request.
Requests API Gateway to get information about a Deployments collection.default CompletableFuture<GetDocumentationPartResponse> getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
getDocumentationPartRequest - Gets a specified documentation part of a given API.default CompletableFuture<GetDocumentationPartResponse> getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest)
This is a convenience which creates an instance of the GetDocumentationPartRequest.Builder avoiding the
need to create one manually via GetDocumentationPartRequest.builder()
getDocumentationPartRequest - A Consumer that will call methods on GetDocumentationPartRequest.Builder to create a
request. Gets a specified documentation part of a given API.default CompletableFuture<GetDocumentationPartsResponse> getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).default CompletableFuture<GetDocumentationPartsResponse> getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest)
This is a convenience which creates an instance of the GetDocumentationPartsRequest.Builder avoiding the
need to create one manually via GetDocumentationPartsRequest.builder()
getDocumentationPartsRequest - A Consumer that will call methods on 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).default CompletableFuture<GetDocumentationVersionResponse> getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
getDocumentationVersionRequest - Gets a documentation snapshot of an API.default CompletableFuture<GetDocumentationVersionResponse> getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest)
This is a convenience which creates an instance of the GetDocumentationVersionRequest.Builder avoiding
the need to create one manually via GetDocumentationVersionRequest.builder()
getDocumentationVersionRequest - A Consumer that will call methods on GetDocumentationVersionRequest.Builder to create a
request. Gets a documentation snapshot of an API.default CompletableFuture<GetDocumentationVersionsResponse> getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
getDocumentationVersionsRequest - Gets the documentation versions of an API.default CompletableFuture<GetDocumentationVersionsResponse> getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest)
This is a convenience which creates an instance of the GetDocumentationVersionsRequest.Builder avoiding
the need to create one manually via GetDocumentationVersionsRequest.builder()
getDocumentationVersionsRequest - A Consumer that will call methods on GetDocumentationVersionsRequest.Builder to create a
request. Gets the documentation versions of an API.default CompletableFuture<GetDomainNameResponse> getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainNameRequest - Request to get the name of a DomainName resource.default CompletableFuture<GetDomainNameResponse> getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest)
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 GetDomainNameRequest.Builder avoiding the need to
create one manually via GetDomainNameRequest.builder()
getDomainNameRequest - A Consumer that will call methods on GetDomainNameRequest.Builder to create a request.
Request to get the name of a DomainName resource.default CompletableFuture<GetDomainNamesResponse> getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
getDomainNamesRequest - Request to describe a collection of DomainName resources.default CompletableFuture<GetDomainNamesResponse> getDomainNames(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
Represents a collection of DomainName resources.
This is a convenience which creates an instance of the GetDomainNamesRequest.Builder avoiding the need to
create one manually via GetDomainNamesRequest.builder()
getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request.
Request to describe a collection of DomainName resources.default CompletableFuture<GetDomainNamesResponse> getDomainNames()
Represents a collection of DomainName resources.
default GetDomainNamesPublisher getDomainNamesPaginator()
Represents a collection of DomainName resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
default GetDomainNamesPublisher getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
getDomainNamesRequest - Request to describe a collection of DomainName resources.default GetDomainNamesPublisher getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
Represents a collection of DomainName resources.
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
This is a convenience which creates an instance of the GetDomainNamesRequest.Builder avoiding the need to
create one manually via GetDomainNamesRequest.builder()
getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request.
Request to describe a collection of DomainName resources.default CompletableFuture<GetExportResponse> getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
getExportRequest - Request a new export of a RestApi for a particular Stage.default CompletableFuture<GetExportResponse> getExport(Consumer<GetExportRequest.Builder> getExportRequest)
Exports a deployed version of a RestApi in a specified format.
This is a convenience which creates an instance of the GetExportRequest.Builder avoiding the need to
create one manually via GetExportRequest.builder()
getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request. Request
a new export of a RestApi for a particular Stage.default CompletableFuture<GetGatewayResponseResponse> getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
getGatewayResponseRequest - Gets a GatewayResponse of a specified response type on the given RestApi.default CompletableFuture<GetGatewayResponseResponse> getGatewayResponse(Consumer<GetGatewayResponseRequest.Builder> getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
This is a convenience which creates an instance of the GetGatewayResponseRequest.Builder avoiding the
need to create one manually via GetGatewayResponseRequest.builder()
getGatewayResponseRequest - A Consumer that will call methods on GetGatewayResponseRequest.Builder to create a
request. Gets a GatewayResponse of a specified response type on the given RestApi.default CompletableFuture<GetGatewayResponsesResponse> getGatewayResponses(GetGatewayResponsesRequest 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.
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.default CompletableFuture<GetGatewayResponsesResponse> getGatewayResponses(Consumer<GetGatewayResponsesRequest.Builder> 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.
This is a convenience which creates an instance of the GetGatewayResponsesRequest.Builder avoiding the
need to create one manually via GetGatewayResponsesRequest.builder()
getGatewayResponsesRequest - A Consumer that will call methods on 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.default CompletableFuture<GetIntegrationResponse> getIntegration(GetIntegrationRequest getIntegrationRequest)
Get the integration settings.
getIntegrationRequest - Represents a request to get the integration configuration.default CompletableFuture<GetIntegrationResponse> getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)
Get the integration settings.
This is a convenience which creates an instance of the GetIntegrationRequest.Builder avoiding the need to
create one manually via GetIntegrationRequest.builder()
getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request.
Represents a request to get the integration configuration.default CompletableFuture<GetIntegrationResponseResponse> getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
getIntegrationResponseRequest - Represents a get integration response request.default CompletableFuture<GetIntegrationResponseResponse> getIntegrationResponse(Consumer<GetIntegrationResponseRequest.Builder> getIntegrationResponseRequest)
Represents a get integration response.
This is a convenience which creates an instance of the GetIntegrationResponseRequest.Builder avoiding the
need to create one manually via GetIntegrationResponseRequest.builder()
getIntegrationResponseRequest - A Consumer that will call methods on GetIntegrationResponseRequest.Builder to create a
request. Represents a get integration response request.default CompletableFuture<GetMethodResponse> getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
getMethodRequest - Request to describe an existing Method resource.default CompletableFuture<GetMethodResponse> getMethod(Consumer<GetMethodRequest.Builder> getMethodRequest)
Describe an existing Method resource.
This is a convenience which creates an instance of the GetMethodRequest.Builder avoiding the need to
create one manually via GetMethodRequest.builder()
getMethodRequest - A Consumer that will call methods on GetMethodRequest.Builder to create a request. Request
to describe an existing Method resource.default CompletableFuture<GetMethodResponseResponse> getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
getMethodResponseRequest - Request to describe a MethodResponse resource.default CompletableFuture<GetMethodResponseResponse> getMethodResponse(Consumer<GetMethodResponseRequest.Builder> getMethodResponseRequest)
Describes a MethodResponse resource.
This is a convenience which creates an instance of the GetMethodResponseRequest.Builder avoiding the need
to create one manually via GetMethodResponseRequest.builder()
getMethodResponseRequest - A Consumer that will call methods on GetMethodResponseRequest.Builder to create a request.
Request to describe a MethodResponse resource.default CompletableFuture<GetModelResponse> getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
getModelRequest - Request to list information about a model in an existing RestApi resource.default CompletableFuture<GetModelResponse> getModel(Consumer<GetModelRequest.Builder> getModelRequest)
Describes an existing model defined for a RestApi resource.
This is a convenience which creates an instance of the GetModelRequest.Builder avoiding the need to
create one manually via GetModelRequest.builder()
getModelRequest - A Consumer that will call methods on GetModelRequest.Builder to create a request. Request
to list information about a model in an existing RestApi resource.default CompletableFuture<GetModelTemplateResponse> getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.default CompletableFuture<GetModelTemplateResponse> getModelTemplate(Consumer<GetModelTemplateRequest.Builder> getModelTemplateRequest)
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 GetModelTemplateRequest.Builder avoiding the need
to create one manually via GetModelTemplateRequest.builder()
getModelTemplateRequest - A Consumer that will call methods on GetModelTemplateRequest.Builder to create a request.
Request to generate a sample mapping template used to transform the payload.default CompletableFuture<GetModelsResponse> getModels(GetModelsRequest getModelsRequest)
getModelsRequest - Request to list existing Models defined for a RestApi resource.default CompletableFuture<GetModelsResponse> getModels(Consumer<GetModelsRequest.Builder> getModelsRequest)
Describes existing Models defined for a RestApi resource.
This is a convenience which creates an instance of the GetModelsRequest.Builder avoiding the need to
create one manually via GetModelsRequest.builder()
getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request
to list existing Models defined for a RestApi resource.default GetModelsPublisher getModelsPaginator(GetModelsRequest getModelsRequest)
Describes existing Models defined for a RestApi resource.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetModelsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.
getModelsRequest - Request to list existing Models defined for a RestApi resource.default GetModelsPublisher getModelsPaginator(Consumer<GetModelsRequest.Builder> getModelsRequest)
Describes existing Models defined for a RestApi resource.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetModelsResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.
This is a convenience which creates an instance of the GetModelsRequest.Builder avoiding the need to
create one manually via GetModelsRequest.builder()
getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request
to list existing Models defined for a RestApi resource.default CompletableFuture<GetRequestValidatorResponse> getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.default CompletableFuture<GetRequestValidatorResponse> getRequestValidator(Consumer<GetRequestValidatorRequest.Builder> getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the GetRequestValidatorRequest.Builder avoiding the
need to create one manually via GetRequestValidatorRequest.builder()
getRequestValidatorRequest - A Consumer that will call methods on GetRequestValidatorRequest.Builder to create a
request. Gets a RequestValidator of a given RestApi.default CompletableFuture<GetRequestValidatorsResponse> getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.default CompletableFuture<GetRequestValidatorsResponse> getRequestValidators(Consumer<GetRequestValidatorsRequest.Builder> getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
This is a convenience which creates an instance of the GetRequestValidatorsRequest.Builder avoiding the
need to create one manually via GetRequestValidatorsRequest.builder()
getRequestValidatorsRequest - A Consumer that will call methods on GetRequestValidatorsRequest.Builder to create a
request. Gets the RequestValidators collection of a given RestApi.default CompletableFuture<GetResourceResponse> getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
getResourceRequest - Request to list information about a resource.default CompletableFuture<GetResourceResponse> getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)
Lists information about a resource.
This is a convenience which creates an instance of the GetResourceRequest.Builder avoiding the need to
create one manually via GetResourceRequest.builder()
getResourceRequest - A Consumer that will call methods on GetResourceRequest.Builder to create a request.
Request to list information about a resource.default CompletableFuture<GetResourcesResponse> getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
getResourcesRequest - Request to list information about a collection of resources.default CompletableFuture<GetResourcesResponse> getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Lists information about a collection of Resource resources.
This is a convenience which creates an instance of the GetResourcesRequest.Builder avoiding the need to
create one manually via GetResourcesRequest.builder()
getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request.
Request to list information about a collection of resources.default GetResourcesPublisher getResourcesPaginator(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetResourcesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.
getResourcesRequest - Request to list information about a collection of resources.default GetResourcesPublisher getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Lists information about a collection of Resource resources.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetResourcesResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.
This is a convenience which creates an instance of the GetResourcesRequest.Builder avoiding the need to
create one manually via GetResourcesRequest.builder()
getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request.
Request to list information about a collection of resources.default CompletableFuture<GetRestApiResponse> getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
getRestApiRequest - The GET request to list an existing RestApi defined for your collection.default CompletableFuture<GetRestApiResponse> getRestApi(Consumer<GetRestApiRequest.Builder> getRestApiRequest)
Lists the RestApi resource in the collection.
This is a convenience which creates an instance of the GetRestApiRequest.Builder avoiding the need to
create one manually via GetRestApiRequest.builder()
getRestApiRequest - A Consumer that will call methods on GetRestApiRequest.Builder to create a request. The
GET request to list an existing RestApi defined for your collection.default CompletableFuture<GetRestApisResponse> getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
getRestApisRequest - The GET request to list existing RestApis defined for your collection.default CompletableFuture<GetRestApisResponse> getRestApis(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
Lists the RestApis resources for your collection.
This is a convenience which creates an instance of the GetRestApisRequest.Builder avoiding the need to
create one manually via GetRestApisRequest.builder()
getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The
GET request to list existing RestApis defined for your collection.default CompletableFuture<GetRestApisResponse> getRestApis()
Lists the RestApis resources for your collection.
default GetRestApisPublisher getRestApisPaginator()
Lists the RestApis resources for your collection.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
default GetRestApisPublisher getRestApisPaginator(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
getRestApisRequest - The GET request to list existing RestApis defined for your collection.default GetRestApisPublisher getRestApisPaginator(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
Lists the RestApis resources for your collection.
This is a variant of 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
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.
Note: If you prefer to have control on service calls, use the
getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
This is a convenience which creates an instance of the GetRestApisRequest.Builder avoiding the need to
create one manually via GetRestApisRequest.builder()
getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The
GET request to list existing RestApis defined for your collection.default CompletableFuture<GetSdkResponse> getSdk(GetSdkRequest getSdkRequest)
getSdkRequest - Request a new generated client SDK for a RestApi and Stage.default CompletableFuture<GetSdkResponse> getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest)
Generates a client SDK for a RestApi and Stage.
This is a convenience which creates an instance of the GetSdkRequest.Builder avoiding the need to create
one manually via GetSdkRequest.builder()
getSdkRequest - A Consumer that will call methods on GetSdkRequest.Builder to create a request. Request a
new generated client SDK for a RestApi and Stage.default CompletableFuture<GetSdkTypeResponse> getSdkType(GetSdkTypeRequest getSdkTypeRequest)
getSdkTypeRequest - Get an SdkType instance.default CompletableFuture<GetSdkTypeResponse> getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest)
This is a convenience which creates an instance of the GetSdkTypeRequest.Builder avoiding the need to
create one manually via GetSdkTypeRequest.builder()
getSdkTypeRequest - A Consumer that will call methods on GetSdkTypeRequest.Builder to create a request. Get an
SdkType instance.default CompletableFuture<GetSdkTypesResponse> getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
getSdkTypesRequest - Get the SdkTypes collection.default CompletableFuture<GetSdkTypesResponse> getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest)
This is a convenience which creates an instance of the GetSdkTypesRequest.Builder avoiding the need to
create one manually via GetSdkTypesRequest.builder()
getSdkTypesRequest - A Consumer that will call methods on GetSdkTypesRequest.Builder to create a request. Get
the SdkTypes collection.default CompletableFuture<GetSdkTypesResponse> getSdkTypes()
default CompletableFuture<GetStageResponse> getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
getStageRequest - Requests API Gateway to get information about a Stage resource.default CompletableFuture<GetStageResponse> getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information about a Stage resource.
This is a convenience which creates an instance of the GetStageRequest.Builder avoiding the need to
create one manually via GetStageRequest.builder()
getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request. Requests
API Gateway to get information about a Stage resource.default CompletableFuture<GetStagesResponse> getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
getStagesRequest - Requests API Gateway to get information about one or more Stage resources.default CompletableFuture<GetStagesResponse> getStages(Consumer<GetStagesRequest.Builder> getStagesRequest)
Gets information about one or more Stage resources.
This is a convenience which creates an instance of the GetStagesRequest.Builder avoiding the need to
create one manually via GetStagesRequest.builder()
getStagesRequest - A Consumer that will call methods on GetStagesRequest.Builder to create a request.
Requests API Gateway to get information about one or more Stage resources.default CompletableFuture<GetTagsResponse> getTags(GetTagsRequest getTagsRequest)
Gets the Tags collection for a given resource.
getTagsRequest - Gets the Tags collection for a given resource.default CompletableFuture<GetTagsResponse> getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Gets the Tags collection for a given resource.
This is a convenience which creates an instance of the GetTagsRequest.Builder avoiding the need to create
one manually via GetTagsRequest.builder()
getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request. Gets the
Tags collection for a given resource.default CompletableFuture<GetUsageResponse> getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.default CompletableFuture<GetUsageResponse> getUsage(Consumer<GetUsageRequest.Builder> getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
This is a convenience which creates an instance of the GetUsageRequest.Builder avoiding the need to
create one manually via GetUsageRequest.builder()
getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET
request to get the usage data of a usage plan in a specified time interval.default GetUsagePublisher getUsagePaginator(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsageResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsageResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.
getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.default GetUsagePublisher getUsagePaginator(Consumer<GetUsageRequest.Builder> getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsageResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsageResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.
This is a convenience which creates an instance of the GetUsageRequest.Builder avoiding the need to
create one manually via GetUsageRequest.builder()
getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET
request to get the usage data of a usage plan in a specified time interval.default CompletableFuture<GetUsagePlanResponse> getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.default CompletableFuture<GetUsagePlanResponse> getUsagePlan(Consumer<GetUsagePlanRequest.Builder> getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
This is a convenience which creates an instance of the GetUsagePlanRequest.Builder avoiding the need to
create one manually via GetUsagePlanRequest.builder()
getUsagePlanRequest - A Consumer that will call methods on GetUsagePlanRequest.Builder to create a request. The
GET request to get a usage plan of a given plan identifier.default CompletableFuture<GetUsagePlanKeyResponse> getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.default CompletableFuture<GetUsagePlanKeyResponse> getUsagePlanKey(Consumer<GetUsagePlanKeyRequest.Builder> getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
This is a convenience which creates an instance of the GetUsagePlanKeyRequest.Builder avoiding the need
to create one manually via GetUsagePlanKeyRequest.builder()
getUsagePlanKeyRequest - A Consumer that will call methods on GetUsagePlanKeyRequest.Builder to create a request.
The GET request to get a usage plan key of a given key identifier.default CompletableFuture<GetUsagePlanKeysResponse> getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.default CompletableFuture<GetUsagePlanKeysResponse> getUsagePlanKeys(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
This is a convenience which creates an instance of the GetUsagePlanKeysRequest.Builder avoiding the need
to create one manually via GetUsagePlanKeysRequest.builder()
getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request.
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.default GetUsagePlanKeysPublisher getUsagePlanKeysPaginator(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
This is a variant of
getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)
operation.
getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.default GetUsagePlanKeysPublisher getUsagePlanKeysPaginator(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
This is a variant of
getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)
operation.
This is a convenience which creates an instance of the GetUsagePlanKeysRequest.Builder avoiding the need
to create one manually via GetUsagePlanKeysRequest.builder()
getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request.
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.default CompletableFuture<GetUsagePlansResponse> getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.default CompletableFuture<GetUsagePlansResponse> getUsagePlans(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
Gets all the usage plans of the caller's account.
This is a convenience which creates an instance of the GetUsagePlansRequest.Builder avoiding the need to
create one manually via GetUsagePlansRequest.builder()
getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The
GET request to get all the usage plans of the caller's account.default CompletableFuture<GetUsagePlansResponse> getUsagePlans()
Gets all the usage plans of the caller's account.
default GetUsagePlansPublisher getUsagePlansPaginator()
Gets all the usage plans of the caller's account.
This is a variant of
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
default GetUsagePlansPublisher getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
This is a variant of
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.default GetUsagePlansPublisher getUsagePlansPaginator(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
Gets all the usage plans of the caller's account.
This is a variant of
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
This is a convenience which creates an instance of the GetUsagePlansRequest.Builder avoiding the need to
create one manually via GetUsagePlansRequest.builder()
getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The
GET request to get all the usage plans of the caller's account.default CompletableFuture<GetVpcLinkResponse> getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
getVpcLinkRequest - Gets a specified VPC link under the caller's account in a region.default CompletableFuture<GetVpcLinkResponse> getVpcLink(Consumer<GetVpcLinkRequest.Builder> getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
This is a convenience which creates an instance of the GetVpcLinkRequest.Builder avoiding the need to
create one manually via GetVpcLinkRequest.builder()
getVpcLinkRequest - A Consumer that will call methods on GetVpcLinkRequest.Builder to create a request. Gets a
specified VPC link under the caller's account in a region.default CompletableFuture<GetVpcLinksResponse> getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.default CompletableFuture<GetVpcLinksResponse> getVpcLinks(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
This is a convenience which creates an instance of the GetVpcLinksRequest.Builder avoiding the need to
create one manually via GetVpcLinksRequest.builder()
getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets
the VpcLinks collection under the caller's account in a selected region.default CompletableFuture<GetVpcLinksResponse> getVpcLinks()
Gets the VpcLinks collection under the caller's account in a selected region.
default GetVpcLinksPublisher getVpcLinksPaginator()
Gets the VpcLinks collection under the caller's account in a selected region.
This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
default GetVpcLinksPublisher getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.default GetVpcLinksPublisher getVpcLinksPaginator(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)
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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new 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
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
This is a convenience which creates an instance of the GetVpcLinksRequest.Builder avoiding the need to
create one manually via GetVpcLinksRequest.builder()
getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets
the VpcLinks collection under the caller's account in a selected region.default CompletableFuture<ImportApiKeysResponse> importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.default CompletableFuture<ImportApiKeysResponse> importApiKeys(Consumer<ImportApiKeysRequest.Builder> importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
This is a convenience which creates an instance of the ImportApiKeysRequest.Builder avoiding the need to
create one manually via ImportApiKeysRequest.builder()
importApiKeysRequest - A Consumer that will call methods on ImportApiKeysRequest.Builder to create a request. The
POST request to import API keys from an external source, such as a CSV-formatted file.default CompletableFuture<ImportDocumentationPartsResponse> importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
importDocumentationPartsRequest - Import documentation parts from an external (e.g., OpenAPI) definition file.default CompletableFuture<ImportDocumentationPartsResponse> importDocumentationParts(Consumer<ImportDocumentationPartsRequest.Builder> importDocumentationPartsRequest)
This is a convenience which creates an instance of the ImportDocumentationPartsRequest.Builder avoiding
the need to create one manually via ImportDocumentationPartsRequest.builder()
importDocumentationPartsRequest - A Consumer that will call methods on ImportDocumentationPartsRequest.Builder to create a
request. Import documentation parts from an external (e.g., OpenAPI) definition file.default CompletableFuture<ImportRestApiResponse> importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the API Gateway control service for creating a new API from an external API definition file.
importRestApiRequest - A POST request to import an API to API Gateway using an input of an API definition file.default CompletableFuture<ImportRestApiResponse> importRestApi(Consumer<ImportRestApiRequest.Builder> importRestApiRequest)
A feature of the API Gateway control service for creating a new API from an external API definition file.
This is a convenience which creates an instance of the ImportRestApiRequest.Builder avoiding the need to
create one manually via ImportRestApiRequest.builder()
importRestApiRequest - A Consumer that will call methods on ImportRestApiRequest.Builder to create a request. A
POST request to import an API to API Gateway using an input of an API definition file.default CompletableFuture<PutGatewayResponseResponse> putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the
given RestApi.default CompletableFuture<PutGatewayResponseResponse> putGatewayResponse(Consumer<PutGatewayResponseRequest.Builder> putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
This is a convenience which creates an instance of the PutGatewayResponseRequest.Builder avoiding the
need to create one manually via PutGatewayResponseRequest.builder()
putGatewayResponseRequest - A Consumer that will call methods on PutGatewayResponseRequest.Builder to create a
request. Creates a customization of a GatewayResponse of a specified response type and status code
on the given RestApi.default CompletableFuture<PutIntegrationResponse> putIntegration(PutIntegrationRequest putIntegrationRequest)
Sets up a method's integration.
putIntegrationRequest - Sets up a method's integration.default CompletableFuture<PutIntegrationResponse> putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)
Sets up a method's integration.
This is a convenience which creates an instance of the PutIntegrationRequest.Builder avoiding the need to
create one manually via PutIntegrationRequest.builder()
putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request.
Sets up a method's integration.default CompletableFuture<PutIntegrationResponseResponse> putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
putIntegrationResponseRequest - Represents a put integration response request.default CompletableFuture<PutIntegrationResponseResponse> putIntegrationResponse(Consumer<PutIntegrationResponseRequest.Builder> putIntegrationResponseRequest)
Represents a put integration.
This is a convenience which creates an instance of the PutIntegrationResponseRequest.Builder avoiding the
need to create one manually via PutIntegrationResponseRequest.builder()
putIntegrationResponseRequest - A Consumer that will call methods on PutIntegrationResponseRequest.Builder to create a
request. Represents a put integration response request.default CompletableFuture<PutMethodResponse> putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
putMethodRequest - Request to add a method to an existing Resource resource.default CompletableFuture<PutMethodResponse> putMethod(Consumer<PutMethodRequest.Builder> putMethodRequest)
Add a method to an existing Resource resource.
This is a convenience which creates an instance of the PutMethodRequest.Builder avoiding the need to
create one manually via PutMethodRequest.builder()
putMethodRequest - A Consumer that will call methods on PutMethodRequest.Builder to create a request. Request
to add a method to an existing Resource resource.default CompletableFuture<PutMethodResponseResponse> putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.default CompletableFuture<PutMethodResponseResponse> putMethodResponse(Consumer<PutMethodResponseRequest.Builder> putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
This is a convenience which creates an instance of the PutMethodResponseRequest.Builder avoiding the need
to create one manually via PutMethodResponseRequest.builder()
putMethodResponseRequest - A Consumer that will call methods on PutMethodResponseRequest.Builder to create a request.
Request to add a MethodResponse to an existing Method resource.default CompletableFuture<PutRestApiResponse> putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.default CompletableFuture<PutRestApiResponse> putRestApi(Consumer<PutRestApiRequest.Builder> putRestApiRequest)
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
This is a convenience which creates an instance of the PutRestApiRequest.Builder avoiding the need to
create one manually via PutRestApiRequest.builder()
putRestApiRequest - A Consumer that will call methods on PutRestApiRequest.Builder to create a request. A PUT
request to update an existing API, with external API definitions specified as the request body.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or updates a tag on a given resource.
tagResourceRequest - Adds or updates a tag on a given resource.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates a tag on a given resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Adds
or updates a tag on a given resource.default CompletableFuture<TestInvokeAuthorizerResponse> testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.default CompletableFuture<TestInvokeAuthorizerResponse> testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
This is a convenience which creates an instance of the TestInvokeAuthorizerRequest.Builder avoiding the
need to create one manually via TestInvokeAuthorizerRequest.builder()
testInvokeAuthorizerRequest - A Consumer that will call methods on TestInvokeAuthorizerRequest.Builder to create a
request. Make a request to simulate the execution of an Authorizer.default CompletableFuture<TestInvokeMethodResponse> testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethodRequest - Make a request to simulate the execution of a Method.default CompletableFuture<TestInvokeMethodResponse> testInvokeMethod(Consumer<TestInvokeMethodRequest.Builder> testInvokeMethodRequest)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
This is a convenience which creates an instance of the TestInvokeMethodRequest.Builder avoiding the need
to create one manually via TestInvokeMethodRequest.builder()
testInvokeMethodRequest - A Consumer that will call methods on TestInvokeMethodRequest.Builder to create a request.
Make a request to simulate the execution of a Method.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a given resource.
untagResourceRequest - Removes a tag from a given resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from a given resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
Removes a tag from a given resource.default CompletableFuture<UpdateAccountResponse> updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
updateAccountRequest - Requests API Gateway to change information about the current Account resource.default CompletableFuture<UpdateAccountResponse> updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
Changes information about the current Account resource.
This is a convenience which creates an instance of the UpdateAccountRequest.Builder avoiding the need to
create one manually via UpdateAccountRequest.builder()
updateAccountRequest - A Consumer that will call methods on UpdateAccountRequest.Builder to create a request.
Requests API Gateway to change information about the current Account resource.default CompletableFuture<UpdateApiKeyResponse> updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
updateApiKeyRequest - A request to change information about an ApiKey resource.default CompletableFuture<UpdateApiKeyResponse> updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest)
Changes information about an ApiKey resource.
This is a convenience which creates an instance of the UpdateApiKeyRequest.Builder avoiding the need to
create one manually via UpdateApiKeyRequest.builder()
updateApiKeyRequest - A Consumer that will call methods on UpdateApiKeyRequest.Builder to create a request. A
request to change information about an ApiKey resource.default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
updateAuthorizerRequest - Request to update an existing Authorizer resource.default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest)
Updates an existing Authorizer resource.
This is a convenience which creates an instance of the UpdateAuthorizerRequest.Builder avoiding the need
to create one manually via UpdateAuthorizerRequest.builder()
updateAuthorizerRequest - A Consumer that will call methods on UpdateAuthorizerRequest.Builder to create a request.
Request to update an existing Authorizer resource.default CompletableFuture<UpdateBasePathMappingResponse> updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.default CompletableFuture<UpdateBasePathMappingResponse> updateBasePathMapping(Consumer<UpdateBasePathMappingRequest.Builder> updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
This is a convenience which creates an instance of the UpdateBasePathMappingRequest.Builder avoiding the
need to create one manually via UpdateBasePathMappingRequest.builder()
updateBasePathMappingRequest - A Consumer that will call methods on UpdateBasePathMappingRequest.Builder to create a
request. A request to change information about the BasePathMapping resource.default CompletableFuture<UpdateClientCertificateResponse> updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
updateClientCertificateRequest - A request to change information about an ClientCertificate resource.default CompletableFuture<UpdateClientCertificateResponse> updateClientCertificate(Consumer<UpdateClientCertificateRequest.Builder> updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
This is a convenience which creates an instance of the UpdateClientCertificateRequest.Builder avoiding
the need to create one manually via UpdateClientCertificateRequest.builder()
updateClientCertificateRequest - A Consumer that will call methods on UpdateClientCertificateRequest.Builder to create a
request. A request to change information about an ClientCertificate resource.default CompletableFuture<UpdateDeploymentResponse> updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
updateDeploymentRequest - Requests API Gateway to change information about a Deployment resource.default CompletableFuture<UpdateDeploymentResponse> updateDeployment(Consumer<UpdateDeploymentRequest.Builder> updateDeploymentRequest)
Changes information about a Deployment resource.
This is a convenience which creates an instance of the UpdateDeploymentRequest.Builder avoiding the need
to create one manually via UpdateDeploymentRequest.builder()
updateDeploymentRequest - A Consumer that will call methods on UpdateDeploymentRequest.Builder to create a request.
Requests API Gateway to change information about a Deployment resource.default CompletableFuture<UpdateDocumentationPartResponse> updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
updateDocumentationPartRequest - Updates an existing documentation part of a given API.default CompletableFuture<UpdateDocumentationPartResponse> updateDocumentationPart(Consumer<UpdateDocumentationPartRequest.Builder> updateDocumentationPartRequest)
This is a convenience which creates an instance of the UpdateDocumentationPartRequest.Builder avoiding
the need to create one manually via UpdateDocumentationPartRequest.builder()
updateDocumentationPartRequest - A Consumer that will call methods on UpdateDocumentationPartRequest.Builder to create a
request. Updates an existing documentation part of a given API.default CompletableFuture<UpdateDocumentationVersionResponse> updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
updateDocumentationVersionRequest - Updates an existing documentation version of an API.default CompletableFuture<UpdateDocumentationVersionResponse> updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest)
This is a convenience which creates an instance of the UpdateDocumentationVersionRequest.Builder avoiding
the need to create one manually via UpdateDocumentationVersionRequest.builder()
updateDocumentationVersionRequest - A Consumer that will call methods on UpdateDocumentationVersionRequest.Builder to create a
request. Updates an existing documentation version of an API.default CompletableFuture<UpdateDomainNameResponse> updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
updateDomainNameRequest - A request to change information about the DomainName resource.default CompletableFuture<UpdateDomainNameResponse> updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest)
Changes information about the DomainName resource.
This is a convenience which creates an instance of the UpdateDomainNameRequest.Builder avoiding the need
to create one manually via UpdateDomainNameRequest.builder()
updateDomainNameRequest - A Consumer that will call methods on UpdateDomainNameRequest.Builder to create a request.
A request to change information about the DomainName resource.default CompletableFuture<UpdateGatewayResponseResponse> updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
updateGatewayResponseRequest - Updates a GatewayResponse of a specified response type on the given RestApi.default CompletableFuture<UpdateGatewayResponseResponse> updateGatewayResponse(Consumer<UpdateGatewayResponseRequest.Builder> updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
This is a convenience which creates an instance of the UpdateGatewayResponseRequest.Builder avoiding the
need to create one manually via UpdateGatewayResponseRequest.builder()
updateGatewayResponseRequest - A Consumer that will call methods on UpdateGatewayResponseRequest.Builder to create a
request. Updates a GatewayResponse of a specified response type on the given RestApi.default CompletableFuture<UpdateIntegrationResponse> updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
updateIntegrationRequest - Represents an update integration request.default CompletableFuture<UpdateIntegrationResponse> updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest)
Represents an update integration.
This is a convenience which creates an instance of the UpdateIntegrationRequest.Builder avoiding the need
to create one manually via UpdateIntegrationRequest.builder()
updateIntegrationRequest - A Consumer that will call methods on UpdateIntegrationRequest.Builder to create a request.
Represents an update integration request.default CompletableFuture<UpdateIntegrationResponseResponse> updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
updateIntegrationResponseRequest - Represents an update integration response request.default CompletableFuture<UpdateIntegrationResponseResponse> updateIntegrationResponse(Consumer<UpdateIntegrationResponseRequest.Builder> updateIntegrationResponseRequest)
Represents an update integration response.
This is a convenience which creates an instance of the UpdateIntegrationResponseRequest.Builder avoiding
the need to create one manually via UpdateIntegrationResponseRequest.builder()
updateIntegrationResponseRequest - A Consumer that will call methods on UpdateIntegrationResponseRequest.Builder to create a
request. Represents an update integration response request.default CompletableFuture<UpdateMethodResponse> updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
updateMethodRequest - Request to update an existing Method resource.default CompletableFuture<UpdateMethodResponse> updateMethod(Consumer<UpdateMethodRequest.Builder> updateMethodRequest)
Updates an existing Method resource.
This is a convenience which creates an instance of the UpdateMethodRequest.Builder avoiding the need to
create one manually via UpdateMethodRequest.builder()
updateMethodRequest - A Consumer that will call methods on UpdateMethodRequest.Builder to create a request.
Request to update an existing Method resource.default CompletableFuture<UpdateMethodResponseResponse> updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
updateMethodResponseRequest - A request to update an existing MethodResponse resource.default CompletableFuture<UpdateMethodResponseResponse> updateMethodResponse(Consumer<UpdateMethodResponseRequest.Builder> updateMethodResponseRequest)
Updates an existing MethodResponse resource.
This is a convenience which creates an instance of the UpdateMethodResponseRequest.Builder avoiding the
need to create one manually via UpdateMethodResponseRequest.builder()
updateMethodResponseRequest - A Consumer that will call methods on UpdateMethodResponseRequest.Builder to create a
request. A request to update an existing MethodResponse resource.default CompletableFuture<UpdateModelResponse> updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
updateModelRequest - Request to update an existing model in an existing RestApi resource.default CompletableFuture<UpdateModelResponse> updateModel(Consumer<UpdateModelRequest.Builder> updateModelRequest)
Changes information about a model.
This is a convenience which creates an instance of the UpdateModelRequest.Builder avoiding the need to
create one manually via UpdateModelRequest.builder()
updateModelRequest - A Consumer that will call methods on UpdateModelRequest.Builder to create a request.
Request to update an existing model in an existing RestApi resource.default CompletableFuture<UpdateRequestValidatorResponse> updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.default CompletableFuture<UpdateRequestValidatorResponse> updateRequestValidator(Consumer<UpdateRequestValidatorRequest.Builder> updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the UpdateRequestValidatorRequest.Builder avoiding the
need to create one manually via UpdateRequestValidatorRequest.builder()
updateRequestValidatorRequest - A Consumer that will call methods on UpdateRequestValidatorRequest.Builder to create a
request. Updates a RequestValidator of a given RestApi.default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
updateResourceRequest - Request to change information about a Resource resource.default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Changes information about a Resource resource.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.
Request to change information about a Resource resource.default CompletableFuture<UpdateRestApiResponse> updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
updateRestApiRequest - Request to update an existing RestApi resource in your collection.default CompletableFuture<UpdateRestApiResponse> updateRestApi(Consumer<UpdateRestApiRequest.Builder> updateRestApiRequest)
Changes information about the specified API.
This is a convenience which creates an instance of the UpdateRestApiRequest.Builder avoiding the need to
create one manually via UpdateRestApiRequest.builder()
updateRestApiRequest - A Consumer that will call methods on UpdateRestApiRequest.Builder to create a request.
Request to update an existing RestApi resource in your collection.default CompletableFuture<UpdateStageResponse> updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
updateStageRequest - Requests API Gateway to change information about a Stage resource.default CompletableFuture<UpdateStageResponse> updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Changes information about a Stage resource.
This is a convenience which creates an instance of the UpdateStageRequest.Builder avoiding the need to
create one manually via UpdateStageRequest.builder()
updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request.
Requests API Gateway to change information about a Stage resource.default CompletableFuture<UpdateUsageResponse> updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
updateUsageRequest - The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
specified API key.default CompletableFuture<UpdateUsageResponse> updateUsage(Consumer<UpdateUsageRequest.Builder> updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
This is a convenience which creates an instance of the UpdateUsageRequest.Builder avoiding the need to
create one manually via UpdateUsageRequest.builder()
updateUsageRequest - A Consumer that will call methods on UpdateUsageRequest.Builder to create a request. The
PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
specified API key.default CompletableFuture<UpdateUsagePlanResponse> updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.default CompletableFuture<UpdateUsagePlanResponse> updateUsagePlan(Consumer<UpdateUsagePlanRequest.Builder> updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
This is a convenience which creates an instance of the UpdateUsagePlanRequest.Builder avoiding the need
to create one manually via UpdateUsagePlanRequest.builder()
updateUsagePlanRequest - A Consumer that will call methods on UpdateUsagePlanRequest.Builder to create a request.
The PATCH request to update a usage plan of a given plan Id.default CompletableFuture<UpdateVpcLinkResponse> updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
updateVpcLinkRequest - Updates an existing VpcLink of a specified identifier.default CompletableFuture<UpdateVpcLinkResponse> updateVpcLink(Consumer<UpdateVpcLinkRequest.Builder> updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
This is a convenience which creates an instance of the UpdateVpcLinkRequest.Builder avoiding the need to
create one manually via UpdateVpcLinkRequest.builder()
updateVpcLinkRequest - A Consumer that will call methods on UpdateVpcLinkRequest.Builder to create a request.
Updates an existing VpcLink of a specified identifier.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.