All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class |
Description |
AbstractShapeBuilder<B extends AbstractShapeBuilder,S extends Shape> |
Abstract builder used to create Shape s.
|
AbstractTrait |
Base implementation of traits.
|
AbstractTrait.Provider |
Basic provider implementation that returns the name of the
provided trait.
|
AbstractTraitBuilder<T extends Trait,B extends AbstractTraitBuilder> |
Provides the shared logic that all trait builders need.
|
AbstractValidator |
Abstract Validator class that has helpful methods for emitting events.
|
ArrayNode |
Represents an array of nodes.
|
AuthIndex |
Computes the effective authentication schemes of an operation
for specific protocols.
|
AuthProtocolsValidator |
Validates that each operation in the closure of a service resolves to a
set of authentication schemes that is compatible with at least 1
authentication scheme of each protocol trait protocol listed on the
service to which it is bound (if the service defines protocols, and
only for protocols that list explicitly supported authentication schemes).
|
AuthTrait |
Represents the Smithy auth trait, used to specify the auth
schemes supported by default for operations bound to a service.
|
AuthTrait.Builder |
|
AuthTrait.Provider |
|
AuthValidator |
Validates that service shapes and every operation bound within a service
marked with the auth trait correspond to an auth scheme defined in
one of the protocols of the service (with the exception of "none").
|
BigDecimalShape |
Represents a integer shape.
|
BigDecimalShape.Builder |
|
BigIntegerShape |
Represents a integer shape.
|
BigIntegerShape.Builder |
|
BlobLengthPlugin |
Validates length trait on blob shapes and members that target blob shapes.
|
BlobShape |
Represents a blob shape.
|
BlobShape.Builder |
|
BooleanNode |
Represents a boolean node.
|
BooleanShape |
Represents a boolean shape.
|
BooleanShape.Builder |
|
BooleanTrait |
Trait implementation that expects an empty object or a boolean
value of true.
|
BooleanTrait.Provider<T extends BooleanTrait> |
Trait provider that expects a boolean value of true.
|
BottomUpIndex |
Computes all of the parent shapes of resources and operations from the bottom-up.
|
BoxTrait |
Indicates that a shape is boxed, meaning a value may or may not be present.
|
BoxTrait.Provider |
|
ByteShape |
Represents a byte shape.
|
ByteShape.Builder |
|
CleanBindings |
Removes operation bindings from resources and services when operations
are removed, and removes resource bindings from services and resources when
resources are removed.
|
CleanOperationStructures |
Removes references to removed structures from operation
input, output, and errors.
|
CleanResourceReferences |
|
CleanStructureAndUnionMembers |
Cleans up structure and union shapes after shapes are removed.
|
CollectionLengthPlugin |
Validates the length trait on both list and set shapes or members that
target them.
|
CollectionShape |
Abstract class representing Set and List shapes.
|
CollectionShape.Builder<B extends CollectionShape.Builder,S extends CollectionShape> |
Builder used to create a List or Set shape.
|
CollectionTrait |
|
CollectionTrait.Provider |
|
CorsTrait |
|
CorsTrait.Builder |
|
CorsTrait.Provider |
|
DefaultNodeFactory |
Default Node factory implementation.
|
DeprecatedTrait |
Marks a shape as deprecated.
|
DeprecatedTrait.Builder |
Builder used to create a DeprecatedTrait.
|
DeprecatedTrait.Provider |
|
DocumentationTrait |
Adds documentation to a model.
|
DocumentationTrait.Provider |
|
DocumentShape |
Represents a document shape.
|
DocumentShape.Builder |
|
DoubleShape |
Represents a double shape.
|
DoubleShape.Builder |
|
DynamicTrait |
A general-purpose trait used to represent traits that are defined in the
model and have no concrete implementation.
|
EndpointTrait |
Defines custom endpoint bindings of an operation.
|
EndpointTrait.Builder |
|
EndpointTrait.Provider |
|
EntityShape |
Abstract class representing service and resource shapes.
|
EntityShape.Builder<B extends EntityShape.Builder,S extends EntityShape> |
Builder used to create a Service or Resource shape.
|
EnumConstantBody |
An enum definition for the enum trait.
|
EnumConstantBody.Builder |
|
EnumTrait |
Constrains string values to one of the predefined enum constants.
|
EnumTrait.Builder |
Builder used to create the enum trait.
|
EnumTrait.Provider |
|
EnumTraitValidator |
Ensures that enum traits are valid.
|
ErrorTrait |
Indicates that a structure can be used as an error.
|
ErrorTrait.Provider |
|
EventHeaderTrait |
Marks a structure member of an event as an event header.
|
EventHeaderTrait.Provider |
|
EventPayloadTrait |
Marks a structure member of an event as the event payload.
|
EventPayloadTrait.Provider |
|
EventPayloadTraitValidator |
Ensures that when an event structure contains an eventPayload member,
that all other members are bound to headers.
|
EventStreamIndex |
Index of operation shapes to event stream information.
|
EventStreamInfo |
Contains extracted event stream information.
|
EventStreamValidator |
Validates inputEventStream and outputEventStream traits.
|
ExamplesTrait |
Defines examples for an operation.
|
ExamplesTrait.Builder |
Builds and examples trait.
|
ExamplesTrait.Example |
A specific example.
|
ExamplesTrait.Example.Builder |
|
ExamplesTrait.Provider |
|
ExamplesTraitValidator |
Validates that examples traits are valid for their operations.
|
ExclusiveStructureMemberTraitValidator |
Validates traits that can only be applied to a single structure member.
|
ExpectationNotMetException |
Thrown by Node methods that expect a node to be of a particular
type or to have a particular member.
|
ExternalDocumentationTrait |
Provides a link to external documentation of a service or operation.
|
ExternalDocumentationTrait.Provider |
|
FloatShape |
Represents a integer shape.
|
FloatShape.Builder |
|
FromSourceLocation |
|
HostLabelTrait |
Binds an input member to a label in the hostPrefix of an endpoint
trait on an operation.
|
HostLabelTrait.Provider |
|
HostLabelTraitValidator |
Validates that hostLabel traits are applied correctly for operation inputs.
|
HttpBinding |
Defines an HTTP message member binding.
|
HttpBinding.Location |
HTTP binding types.
|
HttpBindingIndex |
Computes and indexes the explicit and implicit HTTP bindings of a model.
|
HttpBindingsMissingValidator |
Validates that if any operation in a service uses the http trait,
then all operations use them.
|
HttpErrorTrait |
Defines a custom HTTP status code for error structures.
|
HttpErrorTrait.Provider |
|
HttpHeaderTrait |
Binds a member to an HTTP header.
|
HttpHeaderTrait.Provider |
|
HttpHeaderTraitValidator |
Validates that httpHeader traits are case-insensitively unique.
|
HttpLabelTrait |
Binds a member to a URI label of an input of an operation using
the member name.
|
HttpLabelTrait.Provider |
|
HttpLabelTraitValidator |
Validates that httpLabel traits are applied correctly for operation inputs.
|
HttpMethodSemanticsValidator |
Validates that `http` traits applied to operation shapes use the most
semantically appropriate HTTP method according to RFC 7231.
|
HttpPayloadTrait |
Binds a single structure member to the payload of an HTTP request.
|
HttpPayloadTrait.Provider |
|
HttpPayloadValidator |
Validates that if a payload trait is present then all members of the
input of an operation are bound to part of the message.
|
HttpPrefixHeadersTrait |
Binds a map structure member to prefixed HTTP headers.
|
HttpPrefixHeadersTrait.Provider |
|
HttpPrefixHeadersTraitValidator |
Validates that httpHeader traits do not case-insensitively start with an
httpPrefixHeader on the same structure.
|
HttpQueryTrait |
Binds a member to an HTTP query string.
|
HttpQueryTrait.Provider |
|
HttpQueryTraitValidator |
Validates that httpQuery trait bindings are case-sensitively unique.
|
HttpResponseCodeSemanticsValidator |
Ensures that HTTP response codes are appropriate for operations and errors.
|
HttpTrait |
Defines the HTTP request and response code bindings of an operation.
|
HttpTrait.Builder |
Builder used to create an Http trait.
|
HttpTrait.Provider |
|
HttpUriConflictValidator |
Validates that no two URIs in a service conflict with each other.
|
IdempotencyTokenTrait |
Defines an operation input member that is used to prevent
replayed requests.
|
IdempotencyTokenTrait.Provider |
|
IdempotentTrait |
Indicates that an operation is idempotent.
|
IdempotentTrait.Provider |
|
IdentifierBindingIndex |
Index of operation shapes to the identifiers bound to the operation.
|
IdentifierBindingIndex.BindingType |
|
IdRefPlugin |
Validates that the value contained in a string shape is a valid shape ID
and that the shape ID targets a shape that is in the set of shapes
matching the selector.
|
IdRefTrait |
Indicates that a string value must contain a valid shape ID.
|
IdRefTrait.Builder |
|
IdRefTrait.Provider |
|
InputEventStreamTrait |
Trait implementation of inputEventStream.
|
InputEventStreamTrait.Provider |
|
IntegerShape |
Represents an integer shape.
|
IntegerShape.Builder |
|
InvalidPatternException |
Exception thrown for invalid patterns.
|
InvalidUriPatternException |
Exception thrown for invalid HTTP URI patterns.
|
JsonNameTrait |
Provides a custom name to use when serializing a structure member
name as a JSON object property.
|
JsonNameTrait.Provider |
|
KnowledgeIndex |
Contains an index of computed knowledge about a Model .
|
LengthTrait |
Constrains a shape to minimum and maximum number of elements or size.
|
LengthTrait.Builder |
Builder used to create a LongTrait.
|
LengthTrait.Provider |
|
ListShape |
Represents a list shape.
|
ListShape.Builder |
|
LongShape |
Represents a integer shape.
|
LongShape.Builder |
|
MapLengthPlugin |
Validates the length trait on map shapes or members that target them.
|
MapShape |
Represents a map shape.
|
MapShape.Builder |
|
MediaTypeTrait |
Documents the media type of a blob shape.
|
MediaTypeTrait.Provider |
|
MemberShape |
Represents a member that targets another shape by ID.
|
MemberShape.Builder |
|
Model |
A Smithy model, including shapes, traits, custom traits, validators,
suppressions and metadata.
|
Model.Builder |
Builder used to create a Model.
|
ModelAssembler |
Assembles and validates a Model from documents, files, shapes, and
other sources.
|
ModelDiscovery |
Discovers Smithy models by finding all META-INF/smithy/manifest
files on the class path and loading all of the newline separated relative
model files referenced from the manifest.
|
ModelImportException |
Exception thrown when a model fails to be imported.
|
ModelManifestException |
|
ModelSerializer |
|
ModelSerializer.Builder |
|
ModelSyntaxException |
Thrown when the syntax of the IDL is invalid.
|
ModelTransformer |
Class used to transform Model s.
|
ModelTransformerPlugin |
Plugin service used with ModelTransformer.
|
NeighborProvider |
Provides the neighbor relationships for a given shape.
|
NeighborProviderIndex |
Provides a cache of precomputed neighbors for models.
|
Node |
Base class of for all Smithy model nodes.
|
NodeFactory |
A NodeFactory is responsible for creating a Node objects
from strings.
|
NodeType |
The set of possible node types.
|
NodeValidationVisitor |
Validates Node values provided for Shape definitions.
|
NodeValidationVisitor.Builder |
|
NodeValidatorPlugin |
Applies pluggable validation when validating Node values against
the schema of a Shape (e.g., when validating that the values
provided for a trait in the model are valid for the shape of the trait).
|
NodeVisitor<R> |
Node visitor interface.
|
NodeVisitor.Default<R> |
Creates NodeVisitor that return a default value when necessary
when visiting nodes.
|
NullNode |
Represents a null node.
|
NumberNode |
Represents a number node.
|
NumberShape |
Abstract class representing all numeric types.
|
ObjectNode |
Represents an object node.
|
ObjectNode.Builder |
Builder used to efficiently create an ObjectNode.
|
OperationIndex |
Index of operation IDs to their resolved input, output, and error
structures.
|
OperationShape |
Represents an API operation.
|
OperationShape.Builder |
|
OutputEventStreamTrait |
Trait implementation of outputEventStream.
|
OutputEventStreamTrait.Provider |
|
PaginatedIndex |
Index of operation shapes to paginated trait information.
|
PaginatedTrait |
Defines the pagination functionality of an operation.
|
PaginatedTrait.Builder |
Builds the paginated trait.
|
PaginatedTrait.Provider |
|
PaginatedTraitValidator |
Validates paginated traits.
|
PaginationInfo |
Resolved and valid pagination information about an operation in a service.
|
PathFinder |
Finds the possible directed relationship paths from a starting shape to
shapes connected to the starting shape that match a selector.
|
PathFinder.Path |
An immutable Relationship path from a starting shape to an end shape.
|
Pattern |
Represents a contained pattern.
|
Pattern.Builder |
Builder used to create a Pattern.
|
Pattern.Segment |
Segment within a Pattern.
|
Pattern.Segment.Type |
|
PatternTrait |
Restricts string values to a specified regular expression.
|
PatternTrait.Provider |
|
PatternTraitPlugin |
Validates the pattern trait on string shapes or members that target them.
|
Prelude |
Represents the prelude model available to every Smithy model.
|
PrivateAccessValidator |
Ensures that shapes in separate namespaces don't refer to shapes in other
namespaces that are marked as private.
|
PrivateTrait |
Indicates that a shape cannot be targeted outside of the namespace in
which it was defined.
|
PrivateTrait.Provider |
|
Protocol |
Represents a Smithy protocol.
|
Protocol.Builder |
Protocol builder.
|
ProtocolsTrait |
Defines the protocols supported by a service.
|
ProtocolsTrait.Builder |
Builds the protocols trait.
|
ProtocolsTrait.Provider |
|
RangeTrait |
Constrains a shape to minimum and maximum numeric range.
|
RangeTrait.Builder |
Builder used to create a LongTrait.
|
RangeTrait.Provider |
|
RangeTraitPlugin |
Validates the range trait on number shapes or members that target them.
|
RangeTraitValidator |
Ensures that range traits are valid.
|
ReadonlyTrait |
Indicates that an operation is read-only.
|
ReadonlyTrait.Provider |
|
ReferencesTrait |
Defines references to resources within a structure.
|
ReferencesTrait.Builder |
Builder use to create the references trait.
|
ReferencesTrait.Provider |
|
ReferencesTrait.Reference |
Reference to a resource.
|
ReferencesTrait.Reference.Builder |
|
ReferencesTraitValidator |
Validates that references are correct.
|
Relationship |
Represent a direct relationship between two shapes.
|
RelationshipDirection |
Defines the directionality of a relationship.
|
RelationshipType |
Defines the relationship types between neighboring shapes.
|
RemoveTraits |
Removes traits from shapes when trait definitions are removed.
|
RequiredTrait |
Indicates that a structure member is required.
|
RequiredTrait.Provider |
|
ResourceCycleValidator |
Validates that resource references do not introduce circular hierarchies.
|
ResourceIdentifierBindingValidator |
Validates that operations bound to resource shapes have identifier
bindings for all of the identifiers of the parent of the binding resource,
that operations bound to a resource with the collection
trait are bound using a collection binding, and operations bound with
no collection trait are bound using an instance binding.
|
ResourceIdentifierTrait |
Binds an operation input member to a named identifier of the resource to
which the operation is bound.
|
ResourceIdentifierTrait.Provider |
|
ResourceIdentifierValidator |
Validates that the resource identifiers of children of a resource contain
all of the identifiers as their parents.
|
ResourceLifecycleValidator |
Validates that resource are applied appropriately to resources.
|
ResourceShape |
Represents a resource shape.
|
ResourceShape.Builder |
|
RetryableTrait |
Marks an error structure as retryable.
|
RetryableTrait.Builder |
|
RetryableTrait.Provider |
|
Selector |
Matches a set of shapes using a selector expression.
|
SelectorSyntaxException |
Exception thrown when a selector expression is invalid.
|
SensitiveTrait |
Indicates that the data stored in the shape or member is sensitive and
should be handled with care.
|
SensitiveTrait.Provider |
|
ServiceShape |
Represents a service shape.
|
ServiceShape.Builder |
|
ServiceValidator |
Validates that service shapes do not contain duplicate resource or
operation shape names.
|
SetShape |
Represents a set shape.
|
SetShape.Builder |
|
Severity |
Severity level of a validation exception.
|
Shape |
A Shape defines a model component.
|
ShapeId |
Immutable identifier for each shape in a model.
|
ShapeIdConflictValidator |
Ensures that no two shapes in the model have the same case-insensitive
shape ID.
|
ShapeIdSyntaxException |
Represents a shape ID syntax error.
|
ShapeIndex |
|
ShapeIndex.Builder |
Builder used to construct a ShapeIndex.
|
ShapeType |
An enumeration of the different types in a model.
|
ShapeVisitor<R> |
Shape visitor pattern.
|
ShapeVisitor.Builder<R> |
Creates a ShapeVisitor used to dispatch to functions based
on a model type.
|
ShapeVisitor.Default<R> |
Creates ShapeVisitor that return a value when necessary
when visiting shapes.
|
ShortShape |
Represents a short shape.
|
ShortShape.Builder |
|
SimpleShape |
Abstract class representing all simple type shapes.
|
SinceTrait |
Defines when a shape or member was added to the model.
|
SinceTrait.Provider |
|
SingleOperationBindingValidator |
Validates that an operation is only bound to once in an entire
service closure.
|
SingleResourceBindingValidator |
Validates that a resource is only bound to once in an entire
service closure.
|
SmithyTestCase |
Runs a single test case by loading a model and ensuring the resulting
events match the validation events stored in a newline separated file.
|
SmithyTestCase.Result |
Output of validating a model against a test case.
|
SmithyTestSuite |
Runs test cases against a directory of models and error files.
|
SmithyTestSuite.Error |
Thrown when errors are encountered in the test runner.
|
SmithyTestSuite.Result |
Value result of executing the test suite.
|
SourceException |
|
SourceLocation |
Represents the source location of a model component.
|
StreamingTrait |
Indicates that the the data stored in the shape is very large and should
not be stored in memory, or that the size of the data stored in the
shape is unknown at the start of a request.
|
StreamingTrait.Builder |
|
StreamingTrait.Provider |
|
StringEnumPlugin |
Validates the enum trait on string shapes.
|
StringLengthPlugin |
Validates the length trait on string shapes or members that target them.
|
StringListTrait |
Contains abstract functionality to build traits that contain a list
of strings.
|
StringListTrait.Builder<TRAIT extends StringListTrait,BUILDER extends StringListTrait.Builder> |
Abstract builder to build a StringList trait.
|
StringListTrait.Provider<T extends StringListTrait> |
Trait provider that expects a list of string values.
|
StringListTrait.StringListTraitConstructor<T extends StringListTrait> |
Factory method to create a StringList provider.
|
StringNode |
Represents a string node.
|
StringShape |
Represents a string shape.
|
StringShape.Builder |
|
StringTrait |
Abstract trait class for traits that contain only a string value.
|
StringTrait.Provider<T extends StringTrait> |
Trait provider that expects a string value.
|
StructureShape |
Structure shape that maps shape names to members.
|
StructureShape.Builder |
|
Suppression |
Validator suppression.
|
Suppression.Builder |
Builder used to create suppression definitions.
|
TagsTrait |
Applies tags to a shape.
|
TagsTrait.Builder |
|
TagsTrait.Provider |
|
TargetValidator |
Validates that neighbors target resolvable shapes of the correct type.
|
TimestampFormatPlugin |
Validates that timestamp shapes contain values that are compatible with their
timestampFormat traits or contain values that are numbers or an RFC 3339
date-time production.
|
TimestampFormatTrait |
Defines a custom serialization format for a timestamp.
|
TimestampFormatTrait.Provider |
|
TimestampShape |
Represents a timestamp shape.
|
TimestampShape.Builder |
|
TitleTrait |
Provides a human-readable proper noun title to services and resources.
|
TitleTrait.Provider |
|
ToNode |
A value that can be converted to a Node .
|
TopDownIndex |
Provides top-down access to all resources and operations contained within a
service or resource closure.
|
ToShapeId |
Interface used to convert a shape to a ShapeId.
|
Trait |
Traits provide additional context and semantics to shapes.
|
TraitConflictValidator |
Validates that traits do not conflict.
|
TraitDefinition |
Trait definition trait.
|
TraitDefinition.Builder |
Builder to create a TraitDefinition.
|
TraitDefinition.Provider |
|
TraitFactory |
Creates traits using trait data from a model.
|
TraitService |
Creates traits from Node values.
|
TraitTargetValidator |
Validates that traits are only applied to compatible shapes.
|
TraitValueValidator |
Validates that trait values are valid for their trait definitions.
|
UnionShape |
Tagged union shape that maps member names to member definitions.
|
UnionShape.Builder |
|
UniqueItemsTrait |
Indicates that the members of a list must be unique.
|
UniqueItemsTrait.Provider |
|
UnreferencedShapes |
Finds shapes that are not connected to a service shape, are not trait
definitions, and are not referenced by trait definitions.
|
UnreferencedTraitDefinitions |
Finds trait definitions that are not connected to a service shape.
|
UnstableFeatureValidator |
Emits warnings when unstable features are used in a model, for example
document shapes.
|
UriPattern |
Represents a URI pattern.
|
UseException |
Throw when an error occurs with the IDL's use statements.
|
ValidatedResult<T> |
Represents the result of an operation and the ValidationEvent s
that occurred.
|
ValidatedResultException |
|
ValidationEvent |
A validation event created when validating a model.
|
ValidationEvent.Builder |
Builds ValidationEvent values.
|
ValidationUtils |
Utility methods used when validating.
|
Validator |
|
ValidatorFactory |
Creates built-in Validator instances and Validator
instances loaded by name.
|
ValidatorService |
Represents a service provider for configurable Validators that appear
in Smithy models.
|
ValidatorService.Provider |
Provides a simple abstraction for creating validator service subclasses.
|
Walker |
Walks connected shapes within a shape index.
|
XmlAttributeTrait |
Marks a structure member to be serialized to/from an XML attribute.
|
XmlAttributeTrait.Provider |
|
XmlFlattenedTrait |
|
XmlFlattenedTrait.Provider |
|
XmlNamespaceTrait |
Defines the XML Namespace prefix and URI.
|
XmlNamespaceTrait.Builder |
Builder used to create an XmlNamespace trait.
|
XmlNamespaceTrait.Provider |
|
XmlNamespaceTraitValidator |
Validates that the xmlNamespace traits are applied correctly for structures.
|
XmlNameTrait |
Provides a custom name to use when serializing a structure member
name as a XML object property.
|
XmlNameTrait.Provider |
|