com.amazonaws.services.apigateway.model

Class ImportRestApiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.ImportRestApiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImportRestApiRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

A POST request to import an API to 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 and Description
ImportRestApiRequest()

Method Summary

Modifier and Type	Method and Description
ImportRestApiRequest	addParametersEntry(String key, String value)
ImportRestApiRequest	clearParametersEntries() Removes all the entries added into Parameters.
ImportRestApiRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ByteBuffer	getBody() [Required] 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() A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.
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) [Required] 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) A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.
String	toString() Returns a string representation of this object.
ImportRestApiRequest	withBody(ByteBuffer body) [Required] 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) A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.

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

ImportRestApiRequest

public ImportRestApiRequest()

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 is false.

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 is false.

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 is false.

Returns:

A query parameter to indicate whether to rollback the API creation (true) or not ( false) when a warning is encountered. The default value is false.

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 is false.

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 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 creation (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 creation (true) or not ( false) when a warning is encountered. The default value is false.

getParameters

public Map<String,String> getParameters()

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

 aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
 

Returns:

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'

setParameters

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

 aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
 

Parameters:

parameters - A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'

withParameters

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

 aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
 

Parameters:

parameters - A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

 aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
 

The AWS CLI command to set the regional endpoint on the imported API is:

 aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --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 ImportRestApiRequest addParametersEntry(String key,
                                               String value)

clearParametersEntries

public ImportRestApiRequest 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)

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

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 - [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

getBody

public ByteBuffer getBody()

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

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:

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

withBody

public ImportRestApiRequest withBody(ByteBuffer body)

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

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 - [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

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 ImportRestApiRequest 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()