software.amazon.awssdk.services.apigateway.model

Class ImportDocumentationPartsRequest

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

All Implemented Interfaces:

ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

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

Import documentation parts from an external (e.g., Swagger) definition file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportDocumentationPartsRequest.Builder

Method Summary

Modifier and Type	Method and Description
ByteBuffer	body() [Required] Raw byte array representing the to-be-imported documentation parts.
static ImportDocumentationPartsRequest.Builder	builder()
boolean	equals(Object obj)
Boolean	failOnWarnings() A query parameter to specify whether to rollback the documentation importation (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() A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
String	modeAsString() A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
String	restApiId() [Required] The string identifier of the associated RestApi.
static Class<? extends ImportDocumentationPartsRequest.Builder>	serializableBuilderClass()
ImportDocumentationPartsRequest.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()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

mode

public PutMode mode()

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value 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:

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

See Also:

PutMode

modeAsString

public String modeAsString()

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value 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:

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

See Also:

PutMode

failOnWarnings

public Boolean failOnWarnings()

A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered. The default value is false.

Returns:

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

body

public ByteBuffer body()

[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

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

Returns:

[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

toBuilder

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

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static ImportDocumentationPartsRequest.Builder builder()

serializableBuilderClass

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