public class AbstractAmazonApiGateway extends Object implements AmazonApiGateway
AmazonApiGateway
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonApiGateway() |
public void setEndpoint(String endpoint)
AmazonApiGateway
Callers can pass in just the endpoint (ex:
"apigateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonApiGateway
endpoint
- The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex:
"https://apigateway.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonApiGateway
AmazonApiGateway.setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonApiGateway
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
AmazonApiGateway
Create an ApiKey resource.
createApiKey
in interface AmazonApiGateway
request
- Request to create an ApiKey resource.public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
AmazonApiGateway
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizer
in interface AmazonApiGateway
request
- Request to add a new Authorizer to an existing
RestApi resource.public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
AmazonApiGateway
Creates a new BasePathMapping resource.
createBasePathMapping
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to create a new BasePathMapping
resource.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AmazonApiGateway
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to create a Deployment
resource.public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
AmazonApiGateway
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
request
- A request to create a new domain name.public CreateModelResult createModel(CreateModelRequest request)
AmazonApiGateway
createModel
in interface AmazonApiGateway
request
- Request to add a new Model to an existing RestApi
resource.public CreateResourceResult createResource(CreateResourceRequest request)
AmazonApiGateway
Creates a Resource resource.
createResource
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to create a Resource resource.public CreateRestApiResult createRestApi(CreateRestApiRequest request)
AmazonApiGateway
Creates a new RestApi resource.
createRestApi
in interface AmazonApiGateway
request
- The POST Request to add a new RestApi resource to your
collection.public CreateStageResult createStage(CreateStageRequest request)
AmazonApiGateway
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStage
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to create a Stage resource.public void deleteApiKey(DeleteApiKeyRequest request)
AmazonApiGateway
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
request
- A request to delete the ApiKey resource.public void deleteAuthorizer(DeleteAuthorizerRequest request)
AmazonApiGateway
Deletes an existing Authorizer resource.
deleteAuthorizer
in interface AmazonApiGateway
request
- Request to delete an existing Authorizer resource.public void deleteBasePathMapping(DeleteBasePathMappingRequest request)
AmazonApiGateway
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
request
- A request to delete the BasePathMapping resource.public void deleteClientCertificate(DeleteClientCertificateRequest request)
AmazonApiGateway
Deletes the ClientCertificate resource.
deleteClientCertificate
in interface AmazonApiGateway
request
- A request to delete the ClientCertificate resource.public void deleteDeployment(DeleteDeploymentRequest request)
AmazonApiGateway
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeployment
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to delete a Deployment
resource.public void deleteDomainName(DeleteDomainNameRequest request)
AmazonApiGateway
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
request
- A request to delete the DomainName resource.public void deleteIntegration(DeleteIntegrationRequest request)
AmazonApiGateway
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
request
- Represents a delete integration request.public void deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
AmazonApiGateway
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
request
- Represents a delete integration response request.public void deleteMethod(DeleteMethodRequest request)
AmazonApiGateway
Deletes an existing Method resource.
deleteMethod
in interface AmazonApiGateway
request
- Request to delete an existing Method resource.public void deleteMethodResponse(DeleteMethodResponseRequest request)
AmazonApiGateway
Deletes an existing MethodResponse resource.
deleteMethodResponse
in interface AmazonApiGateway
request
- A request to delete an existing MethodResponse resource.public void deleteModel(DeleteModelRequest request)
AmazonApiGateway
Deletes a model.
deleteModel
in interface AmazonApiGateway
request
- Request to delete an existing model in an existing RestApi
resource.public void deleteResource(DeleteResourceRequest request)
AmazonApiGateway
Deletes a Resource resource.
deleteResource
in interface AmazonApiGateway
request
- Request to delete a Resource.public void deleteRestApi(DeleteRestApiRequest request)
AmazonApiGateway
Deletes the specified API.
deleteRestApi
in interface AmazonApiGateway
request
- Request to delete the specified API from your collection.public void deleteStage(DeleteStageRequest request)
AmazonApiGateway
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to delete a Stage resource.public void flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)
AmazonApiGateway
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCache
in interface AmazonApiGateway
request
- Request to flush authorizer cache entries on a specified stage.public void flushStageCache(FlushStageCacheRequest request)
AmazonApiGateway
Flushes a stage's cache.
flushStageCache
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to flush a stage's cache.public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
AmazonApiGateway
Generates a ClientCertificate resource.
generateClientCertificate
in interface AmazonApiGateway
request
- A request to generate a ClientCertificate resource.public GetAccountResult getAccount(GetAccountRequest request)
AmazonApiGateway
Gets information about the current Account resource.
getAccount
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to get information about the current
Account resource.public GetApiKeyResult getApiKey(GetApiKeyRequest request)
AmazonApiGateway
Gets information about the current ApiKey resource.
getApiKey
in interface AmazonApiGateway
request
- A request to get information about the current ApiKey
resource.public GetApiKeysResult getApiKeys(GetApiKeysRequest request)
AmazonApiGateway
Gets information about the current ApiKeys resource.
getApiKeys
in interface AmazonApiGateway
request
- A request to get information about the current ApiKeys
resource.public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
AmazonApiGateway
Describe an existing Authorizer resource.
getAuthorizer
in interface AmazonApiGateway
request
- Request to describe an existing Authorizer resource.public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
AmazonApiGateway
Describe an existing Authorizers resource.
getAuthorizers
in interface AmazonApiGateway
request
- Request to describe an existing Authorizers resource.public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
AmazonApiGateway
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
request
- Request to describe a BasePathMapping resource.public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)
AmazonApiGateway
Represents a collection of BasePathMapping resources.
getBasePathMappings
in interface AmazonApiGateway
request
- A request to get information about a collection of
BasePathMapping resources.public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest request)
AmazonApiGateway
Gets information about the current ClientCertificate resource.
getClientCertificate
in interface AmazonApiGateway
request
- A request to get information about the current
ClientCertificate resource.public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)
AmazonApiGateway
Gets a collection of ClientCertificate resources.
getClientCertificates
in interface AmazonApiGateway
request
- A request to get information about a collection of
ClientCertificate resources.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonApiGateway
Gets information about a Deployment resource.
getDeployment
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to get information about a
Deployment resource.public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
AmazonApiGateway
Gets information about a Deployments collection.
getDeployments
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to get information about a
Deployments collection.public GetDomainNameResult getDomainName(GetDomainNameRequest request)
AmazonApiGateway
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainName
in interface AmazonApiGateway
request
- Request to get the name of a DomainName resource.public GetDomainNamesResult getDomainNames(GetDomainNamesRequest request)
AmazonApiGateway
Represents a collection of DomainName resources.
getDomainNames
in interface AmazonApiGateway
request
- Request to describe a collection of DomainName resources.public GetExportResult getExport(GetExportRequest request)
AmazonApiGateway
Exports a deployed version of a RestApi in a specified format.
getExport
in interface AmazonApiGateway
request
- Request a new export of a RestApi for a particular
Stage.public GetIntegrationResult getIntegration(GetIntegrationRequest request)
AmazonApiGateway
Represents a get integration.
getIntegration
in interface AmazonApiGateway
request
- Represents a get integration request.public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
AmazonApiGateway
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
request
- Represents a get integration response request.public GetMethodResult getMethod(GetMethodRequest request)
AmazonApiGateway
Describe an existing Method resource.
getMethod
in interface AmazonApiGateway
request
- Request to describe an existing Method resource.public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
AmazonApiGateway
Describes a MethodResponse resource.
getMethodResponse
in interface AmazonApiGateway
request
- Request to describe a MethodResponse resource.public GetModelResult getModel(GetModelRequest request)
AmazonApiGateway
Describes an existing model defined for a RestApi resource.
getModel
in interface AmazonApiGateway
request
- Request to list information about a model in an existing
RestApi resource.public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest request)
AmazonApiGateway
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplate
in interface AmazonApiGateway
request
- Request to generate a sample mapping template used to transform
the payload.public GetModelsResult getModels(GetModelsRequest request)
AmazonApiGateway
getModels
in interface AmazonApiGateway
request
- Request to list existing Models defined for a
RestApi resource.public GetResourceResult getResource(GetResourceRequest request)
AmazonApiGateway
Lists information about a resource.
getResource
in interface AmazonApiGateway
request
- Request to list information about a resource.public GetResourcesResult getResources(GetResourcesRequest request)
AmazonApiGateway
Lists information about a collection of Resource resources.
getResources
in interface AmazonApiGateway
request
- Request to list information about a collection of resources.public GetRestApiResult getRestApi(GetRestApiRequest request)
AmazonApiGateway
Lists the RestApi resource in the collection.
getRestApi
in interface AmazonApiGateway
request
- The GET request to list an existing RestApi defined for
your collection.public GetRestApisResult getRestApis(GetRestApisRequest request)
AmazonApiGateway
Lists the RestApis resources for your collection.
getRestApis
in interface AmazonApiGateway
request
- The GET request to list existing RestApis defined for your
collection.public GetSdkResult getSdk(GetSdkRequest request)
AmazonApiGateway
getSdk
in interface AmazonApiGateway
request
- Request a new generated client SDK for a RestApi and
Stage.public GetStageResult getStage(GetStageRequest request)
AmazonApiGateway
Gets information about a Stage resource.
getStage
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to get information about a
Stage resource.public GetStagesResult getStages(GetStagesRequest request)
AmazonApiGateway
Gets information about one or more Stage resources.
getStages
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to get information about one or more
Stage resources.public ImportRestApiResult importRestApi(ImportRestApiRequest request)
AmazonApiGateway
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
importRestApi
in interface AmazonApiGateway
request
- A POST request to import an API to Amazon API Gateway using an
input of an API definition file.public PutIntegrationResult putIntegration(PutIntegrationRequest request)
AmazonApiGateway
Represents a put integration.
putIntegration
in interface AmazonApiGateway
request
- Represents a put integration request.public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
AmazonApiGateway
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
request
- Represents a put integration response request.public PutMethodResult putMethod(PutMethodRequest request)
AmazonApiGateway
Add a method to an existing Resource resource.
putMethod
in interface AmazonApiGateway
request
- Request to add a method to an existing Resource resource.public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest request)
AmazonApiGateway
Adds a MethodResponse to an existing Method resource.
putMethodResponse
in interface AmazonApiGateway
request
- Request to add a MethodResponse to an existing
Method resource.public PutRestApiResult putRestApi(PutRestApiRequest request)
AmazonApiGateway
A feature of the Amazon 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.
putRestApi
in interface AmazonApiGateway
request
- A PUT request to update an existing API, with external API
definitions specified as the request body.public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
AmazonApiGateway
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizer
in interface AmazonApiGateway
request
- Make a request to simulate the execution of an Authorizer.public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
AmazonApiGateway
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethod
in interface AmazonApiGateway
request
- Make a request to simulate the execution of a Method.public UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonApiGateway
Changes information about the current Account resource.
updateAccount
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to change information about the
current Account resource.public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
AmazonApiGateway
Changes information about an ApiKey resource.
updateApiKey
in interface AmazonApiGateway
request
- A request to change information about an ApiKey resource.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
AmazonApiGateway
Updates an existing Authorizer resource.
updateAuthorizer
in interface AmazonApiGateway
request
- Request to update an existing Authorizer resource.public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
AmazonApiGateway
Changes information about the BasePathMapping resource.
updateBasePathMapping
in interface AmazonApiGateway
request
- A request to change information about the BasePathMapping
resource.public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request)
AmazonApiGateway
Changes information about an ClientCertificate resource.
updateClientCertificate
in interface AmazonApiGateway
request
- A request to change information about an ClientCertificate
resource.public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
AmazonApiGateway
Changes information about a Deployment resource.
updateDeployment
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to change information about a
Deployment resource.public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
AmazonApiGateway
Changes information about the DomainName resource.
updateDomainName
in interface AmazonApiGateway
request
- A request to change information about the DomainName
resource.public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
AmazonApiGateway
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
request
- Represents an update integration request.public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
AmazonApiGateway
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
request
- Represents an update integration response request.public UpdateMethodResult updateMethod(UpdateMethodRequest request)
AmazonApiGateway
Updates an existing Method resource.
updateMethod
in interface AmazonApiGateway
request
- Request to update an existing Method resource.public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
AmazonApiGateway
Updates an existing MethodResponse resource.
updateMethodResponse
in interface AmazonApiGateway
request
- A request to update an existing MethodResponse resource.public UpdateModelResult updateModel(UpdateModelRequest request)
AmazonApiGateway
Changes information about a model.
updateModel
in interface AmazonApiGateway
request
- Request to update an existing model in an existing RestApi
resource.public UpdateResourceResult updateResource(UpdateResourceRequest request)
AmazonApiGateway
Changes information about a Resource resource.
updateResource
in interface AmazonApiGateway
request
- Request to change information about a Resource resource.public UpdateRestApiResult updateRestApi(UpdateRestApiRequest request)
AmazonApiGateway
Changes information about the specified API.
updateRestApi
in interface AmazonApiGateway
request
- Request to update an existing RestApi resource in your
collection.public UpdateStageResult updateStage(UpdateStageRequest request)
AmazonApiGateway
Changes information about a Stage resource.
updateStage
in interface AmazonApiGateway
request
- Requests Amazon API Gateway to change information about a
Stage resource.public void shutdown()
AmazonApiGateway
shutdown
in interface AmazonApiGateway
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonApiGateway
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonApiGateway
request
- The originally executed request.Copyright © 2016. All rights reserved.