software.amazon.smithy.model.knowledge

Class PaginatedIndex

java.lang.Object

software.amazon.smithy.model.knowledge.PaginatedIndex

All Implemented Interfaces:

KnowledgeIndex

public final class PaginatedIndex
extends java.lang.Object
implements KnowledgeIndex

Index of operation shapes to paginated trait information.

This index makes it easy to slice up paginated operations and get the resolved members. This index performs some basic validation of the paginated trait like ensuring that the operation has input and output, and that the members defined in the paginated trait can be found in the input or output of the operation. Additional validation is performed in the PaginatedTraitValidator (which makes use of this index).

Constructor Summary

Constructors

Constructor and Description
PaginatedIndex(Model model)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<PaginationInfo>	getPaginationInfo(ToShapeId service, ToShapeId operation)
static PaginatedIndex	of(Model model)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaginatedIndex

public PaginatedIndex(Model model)

Method Detail

of

public static PaginatedIndex of(Model model)

getPaginationInfo

public java.util.Optional<PaginationInfo> getPaginationInfo(ToShapeId service,
                                                            ToShapeId operation)