Package software.amazon.smithy.model.traits

Class PaginatedTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.PaginatedTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<PaginatedTrait>

public final class PaginatedTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<PaginatedTrait>

Defines the pagination functionality of an operation.

See Also:

PaginatedTraitValidator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaginatedTrait.Builder	Builds the paginated trait.
static class	PaginatedTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static PaginatedTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
java.util.Optional<java.lang.String>	getInputToken()
java.util.Optional<java.lang.String>	getItems()
java.util.Optional<java.lang.String>	getOutputToken()
java.util.Optional<java.lang.String>	getPageSize()
PaginatedTrait	merge(PaginatedTrait other)	Merges this paginated trait with another trait.
PaginatedTrait.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final ShapeId ID

Method Detail

getItems

public java.util.Optional<java.lang.String> getItems()

Returns:

The `items` property of the trait.

getInputToken

public java.util.Optional<java.lang.String> getInputToken()

Returns:

The `inputToken` property of the trait.

getOutputToken

public java.util.Optional<java.lang.String> getOutputToken()

Returns:

The `outputToken` property of the trait.

getPageSize

public java.util.Optional<java.lang.String> getPageSize()

Returns:

The optional `pageSize` property.

merge

public PaginatedTrait merge(PaginatedTrait other)

Merges this paginated trait with another trait.

Values set on this trait take precedence over values of the other trait. This operation is typically performed to merge the paginated trait of an operation with the paginated trait of a service.

If other is null, the current trait is returned as-is.

Parameters:

other - Other trait to merge with.

Returns:

Returns a newly created trait that maintains the same source location.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public PaginatedTrait.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<PaginatedTrait>

builder

public static PaginatedTrait.Builder builder()

Returns:

Returns a paginated trait builder.