com.amazonaws.services.apigateway.model

Class PutRestApiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutRestApiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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()

Method Summary

Modifier and Type	Method and Description
PutRestApiRequest	addParametersEntry(String key, String value) Add a single Parameters entry
PutRestApiRequest	clearParametersEntries() Removes all the entries added into Parameters.
PutRestApiRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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 header parameters as part of the request.
String	getRestApiId() The string identifier of the associated RestApi.
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 header parameters as part of the request.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object.
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 header parameters as part of the request.
PutRestApiRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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 string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

withRestApiId

public PutRestApiRequest withRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

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 header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Returns:

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

setParameters

public void setParameters(Map<String,String> parameters)

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Parameters:

parameters - Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

withParameters

public PutRestApiRequest withParameters(Map<String,String> parameters)

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Parameters:

parameters - Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

Returns:

Returns a reference to this object so that method calls can be chained together.

addParametersEntry

public PutRestApiRequest addParametersEntry(String key,
                                            String value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, java.lang.String>)

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 OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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 OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

getBody

public ByteBuffer getBody()

The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

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 OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

withBody

public PutRestApiRequest withBody(ByteBuffer body)

The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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 OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()