Package software.amazon.awssdk.services.apigateway.model

Class ImportRestApiRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImportRestApiRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
ByteBuffer	body()	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.
int	hashCode()
Map<String,String>	parameters()	Custom header parameters as part of the request.
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

Custom header parameters as part of the request.

Returns:

Custom header parameters as part of the request.

body

public ByteBuffer body()

The POST 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 POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

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>

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