Class ImportRestApiRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddParametersEntry
(String key, String value) Removes all the entries added into Parameters.clone()
Creates a shallow clone of this request.boolean
getBody()
The POST request body containing external API definitions.A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.Custom header parameters as part of the request.int
hashCode()
A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.void
setBody
(ByteBuffer body) The POST request body containing external API definitions.void
setFailOnWarnings
(Boolean failOnWarnings) A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.void
setParameters
(Map<String, String> parameters) Custom header parameters as part of the request.toString()
Returns a string representation of this object; useful for testing and debugging.withBody
(ByteBuffer body) The POST request body containing external API definitions.withFailOnWarnings
(Boolean failOnWarnings) A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.withParameters
(Map<String, String> parameters) Custom header parameters as part of the request.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ImportRestApiRequest
public ImportRestApiRequest()
-
-
Method Details
-
setFailOnWarnings
A query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Parameters:
failOnWarnings
- A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
getFailOnWarnings
A query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Returns:
- A query parameter to indicate whether to rollback the API
creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
withFailOnWarnings
A query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Parameters:
failOnWarnings
- A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered. The default value isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isFailOnWarnings
A query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Returns:
- A query parameter to indicate whether to rollback the API
creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
getParameters
Custom header parameters as part of the request.
- Returns:
- Custom header parameters as part of the request.
-
setParameters
Custom header parameters as part of the request.
- Parameters:
parameters
- Custom header parameters as part of the request.
-
withParameters
Custom header parameters as part of the request.
- Parameters:
parameters
- Custom header parameters as part of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addParametersEntry
-
clearParametersEntries
Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together. -
setBody
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
- Parameters:
body
- The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
-
getBody
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
ByteBuffer
s are stateful. Calling theirget
methods changes theirposition
. We recommend usingByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independentposition
, and callingget
methods on this rather than directly on the returnedByteBuffer
. Doing so will ensure that anyone else using theByteBuffer
will not be affected by changes to theposition
.- Returns:
- The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
-
withBody
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
- Parameters:
body
- The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-