Class PaginationDocs
java.lang.Object
software.amazon.awssdk.codegen.docs.PaginationDocs
-
Constructor Summary
ConstructorDescriptionPaginationDocs
(IntermediateModel intermediateModel, OperationModel operationModel, PaginatorDefinition paginatorDefinition) -
Method Summary
Modifier and TypeMethodDescriptionConstructs additional documentation on the async client operation that is appended to the service documentation.getDocsForAsyncResponseClass
(com.squareup.javapoet.ClassName clientInterface) Constructs javadocs for the generated response classes of a paginated operation in Async client.Constructs additional documentation on the client operation that is appended to the service documentation.getDocsForSyncResponseClass
(com.squareup.javapoet.ClassName clientInterface) Constructs javadocs for the generated response classes in a paginated operation.
-
Constructor Details
-
PaginationDocs
public PaginationDocs(IntermediateModel intermediateModel, OperationModel operationModel, PaginatorDefinition paginatorDefinition)
-
-
Method Details
-
getDocsForSyncOperation
Constructs additional documentation on the client operation that is appended to the service documentation. TODO Add a link to our developer guide which will have more details and sample code. Write a blog post too. -
getDocsForSyncResponseClass
Constructs javadocs for the generated response classes in a paginated operation.- Parameters:
clientInterface
- A java poetClassName
type of the sync client interface
-
getDocsForAsyncOperation
Constructs additional documentation on the async client operation that is appended to the service documentation. -
getDocsForAsyncResponseClass
Constructs javadocs for the generated response classes of a paginated operation in Async client.- Parameters:
clientInterface
- A java poetClassName
type of the Async client interface
-