Package software.amazon.smithy.model.knowledge

Class PaginationInfo

java.lang.Object

software.amazon.smithy.model.knowledge.PaginationInfo

public final class PaginationInfo
extends Object

Resolved and valid pagination information about an operation in a service.

Method Summary

Modifier and Type	Method	Description
StructureShape	getInput()
MemberShape	getInputTokenMember()
Optional<MemberShape>	getItemsMember()	Deprecated. See getItemsMemberPath() to retrieve the full path.
List<MemberShape>	getItemsMemberPath()	Get the resolved items path identifiers as a list of MemberShape.
OperationShape	getOperation()
StructureShape	getOutput()
MemberShape	getOutputTokenMember()	Deprecated. See getOutputTokenMemberPath() to retrieve the full path.
List<MemberShape>	getOutputTokenMemberPath()	Get the resolved output path identifiers as a list of MemberShape.
Optional<MemberShape>	getPageSizeMember()
PaginatedTrait	getPaginatedTrait()	Gets the paginated trait of the operation merged with the service.
ServiceShape	getService()

Methods inherited from class java.lang.Object

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

Method Details

getService

public ServiceShape getService()

getOperation

public OperationShape getOperation()

getInput

public StructureShape getInput()

getOutput

public StructureShape getOutput()

getPaginatedTrait

public PaginatedTrait getPaginatedTrait()

Gets the paginated trait of the operation merged with the service.

Returns:

Returns the resolved paginated trait.

getInputTokenMember

public MemberShape getInputTokenMember()

getOutputTokenMember

@Deprecated
public MemberShape getOutputTokenMember()

Deprecated.

See getOutputTokenMemberPath() to retrieve the full path.

Returns:

the last MemberShape of the output path.

getOutputTokenMemberPath

public List<MemberShape> getOutputTokenMemberPath()

Get the resolved output path identifiers as a list of MemberShape.

Returns:

A list of MemberShape.

getItemsMember

@Deprecated
public Optional<MemberShape> getItemsMember()

Deprecated.

See getItemsMemberPath() to retrieve the full path.

Returns:

the last MemberShape of the items path.

getItemsMemberPath

public List<MemberShape> getItemsMemberPath()

Get the resolved items path identifiers as a list of MemberShape.

Returns:

A list of MemberShape.

getPageSizeMember

public Optional<MemberShape> getPageSizeMember()