Class ImportRestApiRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.apigateway.model.ImportRestApiRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ImportRestApiRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ImportRestApiRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImportRestApiRequest
addParametersEntry(String key, String value)
ImportRestApiRequest
clearParametersEntries()
Removes all the entries added into Parameters.ImportRestApiRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
ByteBuffer
getBody()
The POST request body containing external API definitions.Boolean
getFailOnWarnings()
A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.Map<String,String>
getParameters()
Custom header parameters as part of the request.int
hashCode()
Boolean
isFailOnWarnings()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.ImportRestApiRequest
withBody(ByteBuffer body)
The POST request body containing external API definitions.ImportRestApiRequest
withFailOnWarnings(Boolean failOnWarnings)
A query parameter to indicate whether to rollback the API creation (true
) or not (false
) when a warning is encountered.ImportRestApiRequest
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
-
-
-
-
Method Detail
-
setFailOnWarnings
public void setFailOnWarnings(Boolean 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
.- 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
public Boolean 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
public ImportRestApiRequest withFailOnWarnings(Boolean 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
.- 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
public Boolean 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
public Map<String,String> getParameters()
Custom header parameters as part of the request.
- Returns:
- Custom header parameters as part of the request.
-
setParameters
public void setParameters(Map<String,String> parameters)
Custom header parameters as part of the request.
- Parameters:
parameters
- Custom header parameters as part of the request.
-
withParameters
public ImportRestApiRequest withParameters(Map<String,String> parameters)
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
public ImportRestApiRequest addParametersEntry(String key, String value)
-
clearParametersEntries
public ImportRestApiRequest clearParametersEntries()
Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together.
-
setBody
public void setBody(ByteBuffer body)
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
public ByteBuffer 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
public ImportRestApiRequest withBody(ByteBuffer body)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ImportRestApiRequest 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:
Object.clone()
-
-