Class PaginationDocs
- java.lang.Object
-
- software.amazon.awssdk.codegen.docs.PaginationDocs
-
public class PaginationDocs extends Object
-
-
Constructor Summary
Constructors Constructor Description PaginationDocs(IntermediateModel intermediateModel, OperationModel operationModel, PaginatorDefinition paginatorDefinition)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDocsForAsyncOperation()
Constructs additional documentation on the async client operation that is appended to the service documentation.String
getDocsForAsyncResponseClass(com.squareup.javapoet.ClassName clientInterface)
Constructs javadocs for the generated response classes of a paginated operation in Async client.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.
-
-
-
Constructor Detail
-
PaginationDocs
public PaginationDocs(IntermediateModel intermediateModel, OperationModel operationModel, PaginatorDefinition paginatorDefinition)
-
-
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 poetClassName
type of the sync client interface
-
getDocsForAsyncOperation
public String getDocsForAsyncOperation()
Constructs additional documentation on the async client operation that is appended to the service documentation.
-
getDocsForAsyncResponseClass
public String getDocsForAsyncResponseClass(com.squareup.javapoet.ClassName clientInterface)
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
-
-