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

Class ImportDocumentationPartsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public class ImportDocumentationPartsRequest
extends AmazonWebServiceRequest
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	Description
static interface	ImportDocumentationPartsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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.
int	hashCode()
String	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	restApiId()	[Required] The identifier of an API of the to-be-imported documentation parts.
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.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()

[Required] The identifier of an API of the to-be-imported documentation parts.

Returns:

[Required] The identifier of an API of the to-be-imported documentation parts.

mode

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

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.

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:

[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>

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