software.amazon.awssdk.services.apigateway.model

Class PutRestApiRequest

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

All Implemented Interfaces:

ToCopyableBuilder<PutRestApiRequest.Builder,PutRestApiRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class PutRestApiRequest
extends APIGatewayRequest
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 and Description
static interface	PutRestApiRequest.Builder

Method Summary

Modifier and Type	Method and 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.
<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()
PutMode	mode() The mode query parameter to specify the update mode.
String	modeAsString() The mode query parameter to specify the update mode.
Map<String,String>	parameters() Custom header parameters as part of the request.
String	restApiId() The string identifier of the associated RestApi.
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.awscore.AwsRequest

requestOverrideConfig

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

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

mode

public PutMode mode()

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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

modeAsString

public String modeAsString()

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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 header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json .

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

Returns:

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json .

body

public ByteBuffer body()

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

This method will return a new read-only ByteBuffer each time it is invoked.

Returns:

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

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>

Specified by:

toBuilder in class APIGatewayRequest

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

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