PutRestApiRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.PutRestApiRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class PutRestApiRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
A PUT request to update an existing API, with external API definitions specified as the request body.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutRestApiRequest()

Constructors
Constructor and Description
`PutRestApiRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutRestApiRequest`	`addParametersEntry(String key, String value)`
`PutRestApiRequest`	`clearParametersEntries()` Removes all the entries added into Parameters.
`PutRestApiRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getBody()` The PUT request body containing external API definitions.
`Boolean`	`getFailOnWarnings()` A query parameter to indicate whether to rollback the API update (`true`) or not (`false`) when a warning is encountered.
`String`	`getMode()` The `mode` query parameter to specify the update mode.
`Map<String,String>`	`getParameters()` Custom headers supplied as part of the request.
`String`	`getRestApiId()` The identifier of the RestApi to be updated.
`int`	`hashCode()`
`Boolean`	`isFailOnWarnings()` 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`	`setMode(PutMode mode)` The `mode` query parameter to specify the update mode.
`void`	`setMode(String mode)` The `mode` 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutRestApiRequest`	`withBody(ByteBuffer body)` The PUT request body containing external API definitions.
`PutRestApiRequest`	`withFailOnWarnings(Boolean failOnWarnings)` A query parameter to indicate whether to rollback the API update (`true`) or not (`false`) when a warning is encountered.
`PutRestApiRequest`	`withMode(PutMode mode)` The `mode` query parameter to specify the update mode.
`PutRestApiRequest`	`withMode(String mode)` The `mode` query parameter to specify the update mode.
`PutRestApiRequest`	`withParameters(Map<String,String> parameters)` Custom headers supplied as part of the request.
`PutRestApiRequest`	`withRestApiId(String restApiId)` The identifier of the RestApi to be updated.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutRestApiRequest
```
public PutRestApiRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The identifier of the RestApi to be updated.
    
    Parameters:
    
    restApiId - The identifier of the RestApi to be updated.
  - getRestApiId
```
public String getRestApiId()
```
    The identifier of the RestApi to be updated.
    
    Returns:
    
    The identifier of the RestApi to be updated.
  - withRestApiId
```
public PutRestApiRequest withRestApiId(String restApiId)
```
    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
```
public void setMode(String mode)
```
    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    Parameters:
    
    mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    See Also:
    
    PutMode
  - getMode
```
public String 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:
    
    PutMode
  - withMode
```
public PutRestApiRequest withMode(String mode)
```
    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    Parameters:
    
    mode - The mode 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:
    
    PutMode
  - setMode
```
public void setMode(PutMode mode)
```
    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    Parameters:
    
    mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    See Also:
    
    PutMode
  - withMode
```
public PutRestApiRequest withMode(PutMode mode)
```
    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    
    Parameters:
    
    mode - The mode 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:
    
    PutMode
  - setFailOnWarnings
```
public void setFailOnWarnings(Boolean failOnWarnings)
```
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    
    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 is false.
  - getFailOnWarnings
```
public Boolean getFailOnWarnings()
```
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    
    Returns:
    
    A query parameter to indicate whether to rollback the API update (true) or not ( false) when a warning is encountered. The default value is false.
  - withFailOnWarnings
```
public PutRestApiRequest withFailOnWarnings(Boolean failOnWarnings)
```
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    
    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 is false.
    
    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 update (true) or not (false) when a warning is encountered. The default value is false.
    
    Returns:
    
    A query parameter to indicate whether to rollback the API update (true) or not ( false) when a warning is encountered. The default value is false.
  - getParameters
```
public Map<String,String> getParameters()
```
    Custom headers supplied as part of the request.
    
    Returns:
    
    Custom headers supplied as part of the request.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    Custom headers supplied as part of the request.
    
    Parameters:
    
    parameters - Custom headers supplied as part of the request.
  - withParameters
```
public PutRestApiRequest withParameters(Map<String,String> parameters)
```
    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
```
public PutRestApiRequest addParametersEntry(String key,
                                            String value)
```
  - clearParametersEntries
```
public PutRestApiRequest clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(ByteBuffer body)
```
    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
```
public ByteBuffer getBody()
```
    The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
  - withBody
```
public PutRestApiRequest withBody(ByteBuffer body)
```
    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
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutRestApiRequest 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 class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class PutRestApiRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutRestApiRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setMode

getMode

withMode

setMode

withMode

setFailOnWarnings

getFailOnWarnings

withFailOnWarnings

isFailOnWarnings

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setBody

getBody

withBody

toString

equals

hashCode

clone