apigateway/aws.sdk.kotlin.services.apigateway.model/ImportDocumentationPartsRequest

ImportDocumentationPartsRequest

class ImportDocumentationPartsRequest

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

Types

Builder

class Builder

Companion

object Companion

Properties

body

val body: ByteArray?

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

failOnWarnings

val failOnWarnings: Boolean?

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.

mode

val mode: PutMode?

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.

restApiId

val restApiId: String?

The string identifier of the associated RestApi.

Functions

copy

inline fun copy(block: ImportDocumentationPartsRequest.Builder.() -> Unit = {}): ImportDocumentationPartsRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String