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	equalsBySdkFields(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)
int	hashCode()
boolean	hasParameters() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

failOnWarnings

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

hasParameters

public final boolean hasParameters()

Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameters

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

You can use hasParameters() to see if a value was sent in this field.

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 final 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 6MB.

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 6MB.

toBuilder

public ImportRestApiRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static ImportRestApiRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo