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

Class PutRestApiRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.PutRestApiRequest

All Implemented Interfaces:

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

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

A PUT request to update an existing API, with external API definitions specified as the request body.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRestApiRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
ByteBuffer	body()	The PUT request body containing external API definitions.
static PutRestApiRequest.Builder	builder()
boolean	equals(Object obj)
Boolean	failOnWarnings()	A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered.
int	hashCode()
String	mode()	The mode query parameter to specify the update mode.
Map<String,String>	parameters()	Custom headers supplied as part of the request.
String	restApiId()	The identifier of the RestApi to be updated.
static Class<? extends PutRestApiRequest.Builder>	serializableBuilderClass()
PutRestApiRequest.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

restApiId

public String restApiId()

The identifier of the RestApi to be updated.

Returns:

The identifier of the RestApi to be updated.

mode

public String mode()

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

failOnWarnings

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

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.

parameters

public Map<String,String> parameters()

Custom headers supplied as part of the request.

Returns:

Custom headers supplied as part of the request.

body

public ByteBuffer body()

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

toBuilder

public PutRestApiRequest.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<PutRestApiRequest.Builder,PutRestApiRequest>

Returns:

a builder for type T

builder

public static PutRestApiRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutRestApiRequest.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