Package software.amazon.awssdk.codegen.docs

Class OperationDocs

java.lang.Object

software.amazon.awssdk.codegen.docs.OperationDocs

public final class OperationDocs
extends Object

Provides documentation for an operation method on the client interface. Use getDocs(IntermediateModel, OperationModel, ClientType) to retrieve documentation for the typical overload for an operation (i.e. the one that takes in a request object and returns a response object in the simple case) or use getDocs(IntermediateModel, OperationModel, ClientType, SimpleMethodOverload) with the specified convenience overload as defined in SimpleMethodOverload.

Method Summary

Modifier and Type	Method	Description
static String	getDocs(IntermediateModel model, OperationModel opModel, ClientType clientType)	Get documentation for the SimpleMethodOverload.NORMAL overload.
static String	getDocs(IntermediateModel model, OperationModel opModel, ClientType clientType, SimpleMethodOverload simpleMethodOverload)	Equivalent to calling getDocs(IntermediateModel, OperationModel, ClientType, SimpleMethodOverload, DocConfiguration) with a default DocConfiguration
static String	getDocs(IntermediateModel model, OperationModel opModel, ClientType clientType, SimpleMethodOverload simpleMethodOverload, DocConfiguration docConfig)	Get documentation for a specific SimpleMethodOverload.

Methods inherited from class java.lang.Object

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

Method Detail

getDocs

public static String getDocs(IntermediateModel model,
                             OperationModel opModel,
                             ClientType clientType)

Get documentation for the SimpleMethodOverload.NORMAL overload. That is, the actual implementation that simple methods delegate to.

Parameters:

model - IntermediateModel

opModel - OperationModel to generate Javadocs for.

clientType - Which client type the Javadoc is being generated for.

Returns:

Formatted Javadocs for operation method.

getDocs

public static String getDocs(IntermediateModel model,
                             OperationModel opModel,
                             ClientType clientType,
                             SimpleMethodOverload simpleMethodOverload)

Equivalent to calling getDocs(IntermediateModel, OperationModel, ClientType, SimpleMethodOverload, DocConfiguration) with a default DocConfiguration

getDocs

public static String getDocs(IntermediateModel model,
                             OperationModel opModel,
                             ClientType clientType,
                             SimpleMethodOverload simpleMethodOverload,
                             DocConfiguration docConfig)

Get documentation for a specific SimpleMethodOverload.

Parameters:

model - IntermediateModel

opModel - OperationModel to generate Javadocs for.

clientType - Which client type the Javadoc is being generated for.

simpleMethodOverload - Overload type to generate docs for.

Returns:

Formatted Javadocs for operation method.