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

GetDocumentationPartsRequest

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Types

Builder

class Builder

Companion

object Companion

Properties

limit

val limit: Int?

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

locationStatus

val locationStatus: LocationStatusType?

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

nameQuery

val nameQuery: String?

The name of API entities of the to-be-retrieved documentation parts.

path

val path: String?

The path of API entities of the to-be-retrieved documentation parts.

position

val position: String?

The current pagination position in the paged result set.

restApiId

val restApiId: String?

The string identifier of the associated RestApi.

type

val type: DocumentationPartType?

The type of API entities of the to-be-retrieved documentation parts.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String