Class PutRestApiRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
A PUT request to update an existing API, with external API definitions specified as the request body.
- 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 PUT request body containing external API definitions.A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered.getMode()
Themode
query parameter to specify the update mode.Custom headers supplied as part of the request.The identifier of the RestApi to be updated.int
hashCode()
A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered.void
setBody
(ByteBuffer body) The PUT request body containing external API definitions.void
setFailOnWarnings
(Boolean failOnWarnings) A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered.void
Themode
query parameter to specify the update mode.void
Themode
query parameter to specify the update mode.void
setParameters
(Map<String, String> parameters) Custom headers supplied as part of the request.void
setRestApiId
(String restApiId) The identifier of the RestApi to be updated.toString()
Returns a string representation of this object; useful for testing and debugging.withBody
(ByteBuffer body) The PUT request body containing external API definitions.withFailOnWarnings
(Boolean failOnWarnings) A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered.Themode
query parameter to specify the update mode.Themode
query parameter to specify the update mode.withParameters
(Map<String, String> parameters) Custom headers supplied as part of the request.withRestApiId
(String restApiId) The identifier of the RestApi to be updated.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
-
PutRestApiRequest
public PutRestApiRequest()
-
-
Method Details
-
setRestApiId
The identifier of the RestApi to be updated.
- Parameters:
restApiId
- The identifier of the RestApi to be updated.
-
getRestApiId
The identifier of the RestApi to be updated.
- Returns:
- The identifier of the RestApi to be updated.
-
withRestApiId
The identifier of the RestApi to be updated.
- Parameters:
restApiId
- The identifier of the RestApi to be updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMode
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Parameters:
mode
- Themode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- See Also:
-
getMode
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Returns:
- The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge". - See Also:
-
withMode
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Parameters:
mode
- Themode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setMode
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Parameters:
mode
- Themode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- See Also:
-
withMode
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Parameters:
mode
- Themode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setFailOnWarnings
A query parameter to indicate whether to rollback the API update (
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 update (true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
getFailOnWarnings
A query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Returns:
- A query parameter to indicate whether to rollback the API update
(
true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
withFailOnWarnings
A query parameter to indicate whether to rollback the API update (
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 update (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 update (
true
) or not (false
) when a warning is encountered. The default value isfalse
.- Returns:
- A query parameter to indicate whether to rollback the API update
(
true
) or not (false
) when a warning is encountered. The default value isfalse
.
-
getParameters
Custom headers supplied as part of the request.
- Returns:
- Custom headers supplied as part of the request.
-
setParameters
Custom headers supplied as part of the request.
- Parameters:
parameters
- Custom headers supplied as part of the request.
-
withParameters
Custom headers supplied as part of the request.
- Parameters:
parameters
- Custom headers supplied 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 PUT 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 PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
-
getBody
The PUT 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 PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
-
withBody
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
- Parameters:
body
- The PUT 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:
-