software.amazon.awssdk.codegen.docs

Class PaginationDocs

java.lang.Object

software.amazon.awssdk.codegen.docs.PaginationDocs

public class PaginationDocs
extends Object

Constructor Summary

Constructors

Constructor and Description
PaginationDocs(IntermediateModel intermediateModel, OperationModel operationModel)

Method Summary

Modifier and Type	Method and Description
String	getDocsForSyncOperation() Constructs additional documentation on the client operation that is appended to the service documentation.
String	getDocsForSyncResponseClass(com.squareup.javapoet.ClassName clientInterface) Constructs javadocs for the generated response classes in a paginated operation.
com.squareup.javapoet.ClassName	syncPaginatedResponseType()

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationDocs

public PaginationDocs(IntermediateModel intermediateModel,
                      OperationModel operationModel)

Method Detail

getDocsForSyncOperation

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

public String getDocsForSyncResponseClass(com.squareup.javapoet.ClassName clientInterface)

Constructs javadocs for the generated response classes in a paginated operation.

Parameters:

clientInterface - A java poet ClassName type of the sync client interface

syncPaginatedResponseType

public com.squareup.javapoet.ClassName syncPaginatedResponseType()

Returns:

A Poet ClassName for the return type of sync paginated operation.