software.amazon.awssdk.services.apigateway.model

Class ImportRestApiRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.ImportRestApiRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImportRestApiRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

A POST request to import an API to API Gateway using an input of an API definition file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportRestApiRequest.Builder

Method Summary

Modifier and Type	Method and Description
SdkBytes	body() [Required] The POST request body containing external API definitions.
static ImportRestApiRequest.Builder	builder()
boolean	equals(Object obj)
Boolean	failOnWarnings() A query parameter to indicate whether to rollback the API creation (true) or not (false ) when a warning is encountered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Map<String,String>	parameters() A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportRestApiRequest.Builder>	serializableBuilderClass()
ImportRestApiRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

failOnWarnings

public 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.

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.

parameters

public 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'
 

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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'

body

public SdkBytes 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:

[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.

toBuilder

public ImportRestApiRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static ImportRestApiRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportRestApiRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.