Package software.amazon.awssdk.codegen.docs

Enum SimpleMethodOverload

java.lang.Object

java.lang.Enum<SimpleMethodOverload>

software.amazon.awssdk.codegen.docs.SimpleMethodOverload

All Implemented Interfaces:

Serializable, Comparable<SimpleMethodOverload>

public enum SimpleMethodOverload
extends Enum<SimpleMethodOverload>

Enum describing all the convenience overloads we generate for operation methods.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	Simple method only for sync operations that have a streaming output.
FILE	Simple method for streaming operations (input or output) that takes in the request object and a file to upload from or download to.
INPUT_STREAM	Simple method only for sync operations that have a streaming output.
NO_ARG	Simple method that takes no arguments and creates an empty request object that delegates to the NORMAL overload.
NO_ARG_PAGINATED	Paginated simple method that takes no arguments and creates an empty request object.
NORMAL	The standard method overload.
PAGINATED	The standard paginated method overload that takes in a request object and returns a response object.

Method Summary

Modifier and Type	Method	Description
software.amazon.awssdk.codegen.docs.OperationDocProvider	asyncDocsProvider(IntermediateModel model, OperationModel opModel, DocConfiguration docConfiguration)
software.amazon.awssdk.codegen.docs.OperationDocProvider	syncDocsProvider(IntermediateModel model, OperationModel opModel, DocConfiguration docConfiguration)
static SimpleMethodOverload	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SimpleMethodOverload[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final SimpleMethodOverload NORMAL

The standard method overload. For non-streaming sync this is the method that take in a request object and returns a response object.

PAGINATED

public static final SimpleMethodOverload PAGINATED

The standard paginated method overload that takes in a request object and returns a response object.

NO_ARG

public static final SimpleMethodOverload NO_ARG

Simple method that takes no arguments and creates an empty request object that delegates to the NORMAL overload.

NO_ARG_PAGINATED

public static final SimpleMethodOverload NO_ARG_PAGINATED

Paginated simple method that takes no arguments and creates an empty request object.

FILE

public static final SimpleMethodOverload FILE

Simple method for streaming operations (input or output) that takes in the request object and a file to upload from or download to.

INPUT_STREAM

public static final SimpleMethodOverload INPUT_STREAM

Simple method only for sync operations that have a streaming output. Takes a request object and returns an unmanaged ResponseInputStream to read the response contents.

BYTES

public static final SimpleMethodOverload BYTES

Simple method only for sync operations that have a streaming output. Takes a request object and return a ResponseBytes to give byte-buffer access and convenience methods for type conversion.

Method Detail

values

public static SimpleMethodOverload[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SimpleMethodOverload c : SimpleMethodOverload.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SimpleMethodOverload valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

syncDocsProvider

public software.amazon.awssdk.codegen.docs.OperationDocProvider syncDocsProvider(IntermediateModel model,
                                                                                 OperationModel opModel,
                                                                                 DocConfiguration docConfiguration)

asyncDocsProvider

public software.amazon.awssdk.codegen.docs.OperationDocProvider asyncDocsProvider(IntermediateModel model,
                                                                                  OperationModel opModel,
                                                                                  DocConfiguration docConfiguration)