A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractShapeBuilder<B extends AbstractShapeBuilder,S extends Shape> - Class in software.amazon.smithy.model.shapes
-
Abstract builder used to create
Shape
s. - AbstractTrait - Class in software.amazon.smithy.model.traits
-
Base implementation of traits.
- AbstractTrait(ShapeId, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.AbstractTrait
- AbstractTrait.Provider - Class in software.amazon.smithy.model.traits
-
Basic provider implementation that returns the name of the provided trait.
- AbstractTraitBuilder<T extends Trait,B extends AbstractTraitBuilder> - Class in software.amazon.smithy.model.traits
-
Provides the shared logic that all trait builders need.
- AbstractTraitBuilder() - Constructor for class software.amazon.smithy.model.traits.AbstractTraitBuilder
- AbstractValidator - Class in software.amazon.smithy.model.validation
-
Abstract Validator class that has helpful methods for emitting events.
- AbstractValidator() - Constructor for class software.amazon.smithy.model.validation.AbstractValidator
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.ArrayNode
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.BooleanNode
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.Node
-
Accepts a visitor with the node.
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.NullNode
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.NumberNode
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.ObjectNode
- accept(NodeVisitor<R>) - Method in class software.amazon.smithy.model.node.StringNode
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.BigDecimalShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.BigIntegerShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.BlobShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.BooleanShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.ByteShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.DocumentShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.DoubleShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.FloatShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.IntegerShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.ListShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.LongShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.MapShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.MemberShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.OperationShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.ResourceShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.ServiceShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.SetShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Dispatches the shape to the appropriate
ShapeVisitor
method. - accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.ShortShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.StringShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.StructureShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.TimestampShape
- accept(ShapeVisitor<R>) - Method in class software.amazon.smithy.model.shapes.UnionShape
- addAuth(String) - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Adds an auth scheme to the protocol.
- addCollectionOperation(String) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- addCollectionOperation(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- addConflict(String) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- addConflict(ShapeId) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- addDocumentNode(Node) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds a parsed JSON model file as a
Node
to the assembler. - addEnum(String, EnumConstantBody) - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
- addError(String) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Adds an error to the operation.
- addError(ToShapeId) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Adds an error to the operation.
- addErrors(List<ShapeId>) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Adds an each of the errors to the operation.
- addExample(ExamplesTrait.Example) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- addIdentifier(String, String) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- addIdentifier(String, ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
-
Adds an identifier to the resource.
- addImport(String) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds an import to the assembler.
- addImport(URL) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds an import to the assembler from a URL.
- addImport(Path) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds an import to the assembler.
- additionalAllowedHeaders(Set<String>) - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- additionalExposedHeaders(Set<String>) - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds a member to the shape IFF the shape supports members.
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- addModel(Model) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Merges a loaded model into the model assembler.
- addOperation(String) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- addOperation(ToShapeId) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- addProtocol(Protocol) - Method in class software.amazon.smithy.model.traits.ProtocolsTrait.Builder
-
Adds a protocol to the trait.
- addReference(ReferencesTrait.Reference) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- addResource(String) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- addResource(ToShapeId) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- addShape(String) - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- addShape(Shape) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Explicitly injects a shape into the assembled model.
- addShape(Shape) - Method in class software.amazon.smithy.model.Model.Builder
-
Add a shape to the builder.
- addShape(Shape) - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.Add a shape to the builder.
- addShape(ShapeId) - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- addShapes(Collection<S>) - Method in class software.amazon.smithy.model.Model.Builder
-
Adds a collection of shapes to the builder.
- addShapes(Collection<S>) - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.Adds a collection of shapes to the builder.
- addShapes(Model) - Method in class software.amazon.smithy.model.Model.Builder
-
Adds the shapes of another model to the builder.
- addShapes(Shape...) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Explicitly injects multiple shapes into the assembled model.
- addShapes(Shape...) - Method in class software.amazon.smithy.model.Model.Builder
-
Adds a variadic list of shapes.
- addShapes(Shape...) - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.Adds a variadic list of shapes.
- addShapes(ShapeIndex) - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.Adds the shapes of a ShapeIndex to the builder.
- addSuppression(Suppression) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Registers a suppression to be used when validating the model.
- addTag(String) - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- addTag(String) - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Adds a tag to the protocol.
- addTestCase(SmithyTestCase) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Adds a test case to the test suite.
- addTestCasesFromDirectory(Path) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Adds test cases by crawling a directory and looking for model files that end with ".json" and ".smithy".
- addTestCasesFromUrl(URL) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Convenience method for supplying a directory using a class loader.
- addTrait(Trait) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds a trait to the shape builder, replacing any conflicting traits.
- addTraits(Collection<Trait>) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds traits from an iterator to the shape builder, replacing any conflicting traits.
- addUnparsedModel(String, String) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds a string containing an unparsed model to the assembler.
- addValidator(Validator) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Registers a validator to be used when validating the model.
- addValidatorId(String) - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- addValue(String) - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Adds a value to the builder.
- ALLOW_UNKNOWN_TRAITS - Static variable in class software.amazon.smithy.model.loader.ModelAssembler
-
Allow unknown traits rather than fail.
- allowBoxedNull(boolean) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Configure how null values are handled when they are provided for boxed types.
- allowsGreedyLabels(boolean) - Method in class software.amazon.smithy.model.pattern.Pattern.Builder
- apply(Shape, Node, Model) - Method in interface software.amazon.smithy.model.validation.node.NodeValidatorPlugin
-
Applies the plugin to the given shape, node value, and shape index.
- apply(Shape, Node, ShapeIndex) - Method in interface software.amazon.smithy.model.validation.node.NodeValidatorPlugin
-
Deprecated.
- apply(Shape, Node, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.TimestampFormatPlugin
- ARRAY - software.amazon.smithy.model.node.NodeType
- arrayNode() - Static method in class software.amazon.smithy.model.node.Node
-
Creates an empty
ArrayNode
. - arrayNode(ArrayNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits an array node.
- arrayNode(ArrayNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- arrayNode(Node...) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ArrayNode
from a variadic list of Nodes. - ArrayNode - Class in software.amazon.smithy.model.node
-
Represents an array of nodes.
- ArrayNode(List<Node>, SourceLocation) - Constructor for class software.amazon.smithy.model.node.ArrayNode
- asArrayNode() - Method in class software.amazon.smithy.model.node.ArrayNode
- asArrayNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an ArrayNode if it is an array.
- asBigDecimalShape() - Method in class software.amazon.smithy.model.shapes.BigDecimalShape
- asBigDecimalShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asBigIntegerShape() - Method in class software.amazon.smithy.model.shapes.BigIntegerShape
- asBigIntegerShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asBlobShape() - Method in class software.amazon.smithy.model.shapes.BlobShape
- asBlobShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asBooleanNode() - Method in class software.amazon.smithy.model.node.BooleanNode
- asBooleanNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an BooleanNode if it is an boolean.
- asBooleanShape() - Method in class software.amazon.smithy.model.shapes.BooleanShape
- asBooleanShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asByteShape() - Method in class software.amazon.smithy.model.shapes.ByteShape
- asByteShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asDocumentShape() - Method in class software.amazon.smithy.model.shapes.DocumentShape
- asDocumentShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asDoubleShape() - Method in class software.amazon.smithy.model.shapes.DoubleShape
- asDoubleShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asFloatShape() - Method in class software.amazon.smithy.model.shapes.FloatShape
- asFloatShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asIntegerShape() - Method in class software.amazon.smithy.model.shapes.IntegerShape
- asIntegerShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asListShape() - Method in class software.amazon.smithy.model.shapes.ListShape
- asListShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asLongShape() - Method in class software.amazon.smithy.model.shapes.LongShape
- asLongShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asMapShape() - Method in class software.amazon.smithy.model.shapes.MapShape
- asMapShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asMemberShape() - Method in class software.amazon.smithy.model.shapes.MemberShape
- asMemberShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asNullNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an NullNode if it is a null.
- asNullNode() - Method in class software.amazon.smithy.model.node.NullNode
- asNumberNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an NumberNode if it is an number.
- asNumberNode() - Method in class software.amazon.smithy.model.node.NumberNode
- asObjectNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an ObjectNode if it is an object.
- asObjectNode() - Method in class software.amazon.smithy.model.node.ObjectNode
- asOperationShape() - Method in class software.amazon.smithy.model.shapes.OperationShape
- asOperationShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asRelativeReference() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates a string that contains a relative reference to the ID.
- asResourceShape() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- asResourceShape() - Method in class software.amazon.smithy.model.shapes.Shape
- assemble() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Assembles the model and returns the validated result.
- assembler() - Static method in class software.amazon.smithy.model.Model
-
Assembles and validates a Smithy model from files, nodes, and other disparate sources.
- assembler(ClassLoader) - Static method in class software.amazon.smithy.model.Model
-
Creates a
ModelAssembler
that is configured to discover traits, validators, and built-in validators using the givenClassLoader
. - assertEquals(ToNode, ToNode) - Static method in class software.amazon.smithy.model.node.Node
-
Testing helper used to compare two Nodes for equivalence.
- asServiceShape() - Method in class software.amazon.smithy.model.shapes.ServiceShape
- asServiceShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asSetShape() - Method in class software.amazon.smithy.model.shapes.SetShape
- asSetShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asShortShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asShortShape() - Method in class software.amazon.smithy.model.shapes.ShortShape
- asStringNode() - Method in class software.amazon.smithy.model.node.Node
-
Gets the node as an StringNode if it is an string.
- asStringNode() - Method in class software.amazon.smithy.model.node.StringNode
- asStringShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asStringShape() - Method in class software.amazon.smithy.model.shapes.StringShape
- asStructureShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asStructureShape() - Method in class software.amazon.smithy.model.shapes.StructureShape
- asTimestampShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asTimestampShape() - Method in class software.amazon.smithy.model.shapes.TimestampShape
- asUnionShape() - Method in class software.amazon.smithy.model.shapes.Shape
- asUnionShape() - Method in class software.amazon.smithy.model.shapes.UnionShape
- AuthIndex - Class in software.amazon.smithy.model.knowledge
-
Computes the effective authentication schemes of an operation for specific protocols.
- AuthIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.AuthIndex
- AuthProtocolsValidator - Class in software.amazon.smithy.model.validation.validators
-
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).
- AuthProtocolsValidator() - Constructor for class software.amazon.smithy.model.validation.validators.AuthProtocolsValidator
- AuthTrait - Class in software.amazon.smithy.model.traits
-
Represents the Smithy
auth
trait, used to specify the auth schemes supported by default for operations bound to a service. - AuthTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builds an
AuthTrait
. - AuthTrait.Provider - Class in software.amazon.smithy.model.traits
- AuthValidator - Class in software.amazon.smithy.model.validation.validators
-
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").
- AuthValidator() - Constructor for class software.amazon.smithy.model.validation.validators.AuthValidator
B
- BIG_DECIMAL - software.amazon.smithy.model.shapes.ShapeType
- BIG_INTEGER - software.amazon.smithy.model.shapes.ShapeType
- bigDecimalShape(BigDecimalShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- bigDecimalShape(BigDecimalShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- bigDecimalShape(BigDecimalShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- BigDecimalShape - Class in software.amazon.smithy.model.shapes
-
Represents a
integer
shape. - BigDecimalShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
BigDecimalShape
. - bigIntegerShape(BigIntegerShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- bigIntegerShape(BigIntegerShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- bigIntegerShape(BigIntegerShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- BigIntegerShape - Class in software.amazon.smithy.model.shapes
-
Represents a
integer
shape. - BigIntegerShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
BigIntegerShape
. - BLOB - software.amazon.smithy.model.shapes.ShapeType
- BlobLengthPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates length trait on blob shapes and members that target blob shapes.
- BlobLengthPlugin() - Constructor for class software.amazon.smithy.model.validation.node.BlobLengthPlugin
- blobShape(BlobShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- blobShape(BlobShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- blobShape(BlobShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- BlobShape - Class in software.amazon.smithy.model.shapes
-
Represents a
blob
shape. - BlobShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
BlobShape
. - BOOLEAN - software.amazon.smithy.model.node.NodeType
- BOOLEAN - software.amazon.smithy.model.shapes.ShapeType
- booleanNode(BooleanNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits a boolean node.
- booleanNode(BooleanNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- BooleanNode - Class in software.amazon.smithy.model.node
-
Represents a boolean node.
- BooleanNode(boolean, SourceLocation) - Constructor for class software.amazon.smithy.model.node.BooleanNode
- booleanShape(BooleanShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- booleanShape(BooleanShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- booleanShape(BooleanShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- BooleanShape - Class in software.amazon.smithy.model.shapes
-
Represents a
boolean
shape. - BooleanShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
BooleanShape
. - BooleanTrait - Class in software.amazon.smithy.model.traits
-
Trait implementation that expects an empty object or a boolean value of true.
- BooleanTrait(ShapeId, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.BooleanTrait
- BooleanTrait.Provider<T extends BooleanTrait> - Class in software.amazon.smithy.model.traits
-
Trait provider that expects a boolean value of true.
- bottomUp(Model) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
- bottomUp(ShapeIndex) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Deprecated.
- BottomUpIndex - Class in software.amazon.smithy.model.knowledge
-
Computes all of the parent shapes of resources and operations from the bottom-up.
- BottomUpIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.BottomUpIndex
- BOUND - software.amazon.smithy.model.neighbor.RelationshipType
-
A BINDING relationship exists between the following shapes: Between an operation and the service or resource that the operation is bound to (through operations or a lifecycle). Between a resource and the resource or service that the resource is bound to in the "resources" property. The subject of the relationship is that shape that was bound, and the target is the shape that declared the binding.
- BoxIndex - Class in software.amazon.smithy.model.knowledge
-
An index that checks if a shape is boxed or not.
- BoxIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.BoxIndex
- BoxTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a shape is boxed, meaning a value may or may not be present.
- BoxTrait() - Constructor for class software.amazon.smithy.model.traits.BoxTrait
- BoxTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.BoxTrait
- BoxTrait.Provider - Class in software.amazon.smithy.model.traits
- build() - Method in class software.amazon.smithy.model.Model.Builder
- build() - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- build() - Method in class software.amazon.smithy.model.pattern.Pattern.Builder
- build() - Method in class software.amazon.smithy.model.shapes.BigDecimalShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.BigIntegerShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.BlobShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.BooleanShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ByteShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.DocumentShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.DoubleShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.FloatShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.IntegerShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ListShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.LongShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.MemberShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
- build() - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.
- build() - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
- build() - Method in class software.amazon.smithy.model.shapes.ShortShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.StringShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.StructureShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.TimestampShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- build() - Method in class software.amazon.smithy.model.traits.AuthTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
- build() - Method in class software.amazon.smithy.model.traits.EndpointTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- build() - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- build() - Method in class software.amazon.smithy.model.traits.HttpTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.IdRefTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.LengthTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.Protocol.Builder
- build() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.RangeTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- build() - Method in class software.amazon.smithy.model.traits.RetryableTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.StreamingTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.TagsTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- build() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Builder
- build() - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
- build() - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- build() - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
- builder() - Static method in class software.amazon.smithy.model.Model
-
Builds an explicitly configured Smithy model.
- builder() - Static method in class software.amazon.smithy.model.pattern.Pattern
- builder() - Static method in class software.amazon.smithy.model.shapes.BigDecimalShape
- builder() - Static method in class software.amazon.smithy.model.shapes.BigIntegerShape
- builder() - Static method in class software.amazon.smithy.model.shapes.BlobShape
- builder() - Static method in class software.amazon.smithy.model.shapes.BooleanShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ByteShape
- builder() - Static method in class software.amazon.smithy.model.shapes.DocumentShape
- builder() - Static method in class software.amazon.smithy.model.shapes.DoubleShape
- builder() - Static method in class software.amazon.smithy.model.shapes.FloatShape
- builder() - Static method in class software.amazon.smithy.model.shapes.IntegerShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ListShape
- builder() - Static method in class software.amazon.smithy.model.shapes.LongShape
- builder() - Static method in class software.amazon.smithy.model.shapes.MapShape
- builder() - Static method in class software.amazon.smithy.model.shapes.MemberShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ModelSerializer
- builder() - Static method in class software.amazon.smithy.model.shapes.OperationShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ResourceShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ServiceShape
- builder() - Static method in class software.amazon.smithy.model.shapes.SetShape
- builder() - Static method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.
- builder() - Static method in class software.amazon.smithy.model.shapes.ShortShape
- builder() - Static method in class software.amazon.smithy.model.shapes.StringShape
- builder() - Static method in class software.amazon.smithy.model.shapes.StructureShape
- builder() - Static method in class software.amazon.smithy.model.shapes.TimestampShape
- builder() - Static method in class software.amazon.smithy.model.shapes.UnionShape
- builder() - Static method in class software.amazon.smithy.model.traits.AuthTrait
- builder() - Static method in class software.amazon.smithy.model.traits.CorsTrait
- builder() - Static method in class software.amazon.smithy.model.traits.DeprecatedTrait
- builder() - Static method in class software.amazon.smithy.model.traits.EffectiveTraitQuery
-
Creates a new query builder.
- builder() - Static method in class software.amazon.smithy.model.traits.EndpointTrait
- builder() - Static method in class software.amazon.smithy.model.traits.EnumConstantBody
- builder() - Static method in class software.amazon.smithy.model.traits.EnumTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ExamplesTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- builder() - Static method in class software.amazon.smithy.model.traits.HttpTrait
- builder() - Static method in class software.amazon.smithy.model.traits.IdRefTrait
- builder() - Static method in class software.amazon.smithy.model.traits.LengthTrait
- builder() - Static method in class software.amazon.smithy.model.traits.PaginatedTrait
- builder() - Static method in class software.amazon.smithy.model.traits.Protocol
- builder() - Static method in class software.amazon.smithy.model.traits.ProtocolsTrait
- builder() - Static method in class software.amazon.smithy.model.traits.RangeTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ReferencesTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- builder() - Static method in class software.amazon.smithy.model.traits.RetryableTrait
-
Creates a builder for a retryable trait.
- builder() - Static method in class software.amazon.smithy.model.traits.StreamingTrait
-
Creates a builder for a streaming trait.
- builder() - Static method in class software.amazon.smithy.model.traits.TagsTrait
- builder() - Static method in class software.amazon.smithy.model.traits.TraitDefinition
- builder() - Static method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- builder() - Static method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- builder() - Static method in class software.amazon.smithy.model.validation.Suppression
- builder() - Static method in class software.amazon.smithy.model.validation.ValidationEvent
- Builder() - Constructor for class software.amazon.smithy.model.shapes.BigDecimalShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.BigIntegerShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.BlobShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.BooleanShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ByteShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.CollectionShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.DocumentShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.DoubleShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.EntityShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.FloatShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.IntegerShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ListShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.LongShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.MapShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.MemberShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.OperationShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ResourceShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ServiceShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.SetShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ShortShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.StringShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.StructureShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.TimestampShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.UnionShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EnumTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.HttpTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.LengthTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.Protocol.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.RangeTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.StringListTrait.Builder
- BYTE - software.amazon.smithy.model.shapes.ShapeType
- byteShape(ByteShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- byteShape(ByteShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- byteShape(ByteShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- ByteShape - Class in software.amazon.smithy.model.shapes
-
Represents a
byte
shape. - ByteShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ByteShape
.
C
- canSuppress() - Method in enum software.amazon.smithy.model.validation.Severity
-
Check if the severity level of the error can be suppressed.
- check(Shape, IdRefTrait, StringNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.IdRefPlugin
- check(Shape, LengthTrait, ArrayNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.CollectionLengthPlugin
- check(Shape, LengthTrait, ObjectNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.MapLengthPlugin
- check(Shape, LengthTrait, StringNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.BlobLengthPlugin
- check(Shape, LengthTrait, StringNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.StringLengthPlugin
- check(Shape, PatternTrait, StringNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.PatternTraitPlugin
- check(Shape, RangeTrait, NumberNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.RangeTraitPlugin
- check(StringShape, StringNode, ShapeIndex) - Method in class software.amazon.smithy.model.validation.node.StringEnumPlugin
- CleanBindings - Class in software.amazon.smithy.model.transform.plugins
-
Removes operation bindings from resources and services when operations are removed, and removes resource bindings from services and resources when resources are removed.
- CleanBindings() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanBindings
- CleanOperationStructures - Class in software.amazon.smithy.model.transform.plugins
-
Removes references to removed structures from operation input, output, and errors.
- CleanOperationStructures() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanOperationStructures
- CleanResourceReferences - Class in software.amazon.smithy.model.transform.plugins
-
Removes references to resources that are removed from
ReferencesTrait
s. - CleanResourceReferences() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanResourceReferences
- CleanStructureAndUnionMembers - Class in software.amazon.smithy.model.transform.plugins
-
Cleans up structure and union shapes after shapes are removed.
- CleanStructureAndUnionMembers() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanStructureAndUnionMembers
- clearAuth() - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Removes all auth schemes from the protocol.
- clearCollectionOperations() - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- clearEnums() - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
- clearErrors() - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Removes all errors.
- clearExamples() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- clearMetadata() - Method in class software.amazon.smithy.model.Model.Builder
- clearOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- clearProtocols() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait.Builder
-
Clears all protocols from the trait.
- clearReferences() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- clearResources() - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- clearTags() - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- clearTags() - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Removes all tags from the protocol.
- clearTraits() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes all traits.
- clearValues() - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Clears all values out of the builder.
- code(int) - Method in class software.amazon.smithy.model.traits.HttpTrait.Builder
- coerceTraitValue(Node, ShapeType) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Coerces a trait value for the given type.
- collect() - Static method in class software.amazon.smithy.model.node.ArrayNode
- collect(Function<T, StringNode>, Function<T, ToNode>) - Static method in class software.amazon.smithy.model.node.ObjectNode
-
Creates a collector that creates an ObjectNode.
- collect(SourceLocation) - Static method in class software.amazon.smithy.model.node.ArrayNode
- COLLECTION - software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Indicates that the operation is bound to a resource as a collection operation.
- COLLECTION_OPERATION - software.amazon.smithy.model.neighbor.RelationshipType
-
A collection operation relationship exists between a resource and the operations bound to the resource in the "collectionOperations", "create", and "list" properties.
- CollectionLengthPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the length trait on both list and set shapes or members that target them.
- CollectionLengthPlugin() - Constructor for class software.amazon.smithy.model.validation.node.CollectionLengthPlugin
- collectionOperations(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- CollectionShape - Class in software.amazon.smithy.model.shapes
-
Abstract class representing Set and List shapes.
- CollectionShape.Builder<B extends CollectionShape.Builder,S extends CollectionShape> - Class in software.amazon.smithy.model.shapes
-
Builder used to create a List or Set shape.
- collectStringKeys(Function<T, String>, Function<T, ToNode>) - Static method in class software.amazon.smithy.model.node.ObjectNode
-
Creates a collector that creates an ObjectNode.
- compareTo(Shape) - Method in class software.amazon.smithy.model.shapes.Shape
- compareTo(ShapeId) - Method in class software.amazon.smithy.model.shapes.ShapeId
- compareTo(ValidationEvent) - Method in class software.amazon.smithy.model.validation.ValidationEvent
- compute(Model) - Method in class software.amazon.smithy.model.neighbor.UnreferencedShapes
-
Gets the set of shapes that are unreferenced.
- compute(Model) - Method in class software.amazon.smithy.model.neighbor.UnreferencedTraitDefinitions
- CONFLICTS_KEY - Static variable in class software.amazon.smithy.model.traits.TraitDefinition
- conflictsWith(UriPattern) - Method in class software.amazon.smithy.model.pattern.UriPattern
-
Determines if the pattern conflicts with another pattern.
- containsMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Checks if the given member name exists in the ObjectNode.
- ContextualValidationEventFormatter - Class in software.amazon.smithy.model.validation
-
This validation event formatter outputs a validation event that points to the source code line that triggered the event.
- ContextualValidationEventFormatter() - Constructor for class software.amazon.smithy.model.validation.ContextualValidationEventFormatter
- copy() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Creates a copy of the current model assembler.
- CorsTrait - Class in software.amazon.smithy.model.traits
- CorsTrait.Builder - Class in software.amazon.smithy.model.traits
- CorsTrait.Provider - Class in software.amazon.smithy.model.traits
- create() - Static method in class software.amazon.smithy.model.transform.ModelTransformer
-
Creates a ModelTransformer using ModelTransformerPlugin instances discovered using the
com.software.smithy.transform
class loader and any modules found in the module path. - create(Class<T>, Model) - Static method in interface software.amazon.smithy.model.knowledge.KnowledgeIndex
-
Creates a KnowledgeIndex for a particular class.
- create(List<String>, FromSourceLocation) - Method in interface software.amazon.smithy.model.traits.StringListTrait.StringListTraitConstructor
-
Wraps the constructor of a StringList trait.
- create(Model) - Static method in class software.amazon.smithy.model.selector.PathFinder
-
Creates a
PathFinder
that uses the givenModel
. - create(ShapeIndex) - Static method in class software.amazon.smithy.model.selector.PathFinder
-
Deprecated.
- create(Shape, RelationshipType, Shape) - Static method in class software.amazon.smithy.model.neighbor.Relationship
-
Constructs a valid shape relationship where the neighbor is present.
- create(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- CREATE - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the create lifecycle operation.
- createInvalid(Shape, RelationshipType, ShapeId) - Static method in class software.amazon.smithy.model.neighbor.Relationship
-
Constructs an invalid shape relationship where the neighbor is not present.
- createLazyString(String, SourceLocation) - Static method in class software.amazon.smithy.model.node.StringNode
-
Creates a StringNode that is lazily populated with a value provided by the given
Supplier
. - createNode() - Method in class software.amazon.smithy.model.traits.AbstractTrait
-
The result of toNode is used for hashCodes and equality.
- createNode() - Method in class software.amazon.smithy.model.traits.BooleanTrait
- createNode() - Method in class software.amazon.smithy.model.traits.CorsTrait
- createNode() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait
- createNode() - Method in class software.amazon.smithy.model.traits.DynamicTrait
- createNode() - Method in class software.amazon.smithy.model.traits.EndpointTrait
- createNode() - Method in class software.amazon.smithy.model.traits.EnumTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ExamplesTrait
- createNode() - Method in class software.amazon.smithy.model.traits.HttpErrorTrait
- createNode() - Method in class software.amazon.smithy.model.traits.HttpTrait
- createNode() - Method in class software.amazon.smithy.model.traits.IdRefTrait
- createNode() - Method in class software.amazon.smithy.model.traits.LengthTrait
- createNode() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
- createNode() - Method in class software.amazon.smithy.model.traits.RangeTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait
- createNode() - Method in class software.amazon.smithy.model.traits.RetryableTrait
- createNode() - Method in class software.amazon.smithy.model.traits.StreamingTrait
- createNode() - Method in class software.amazon.smithy.model.traits.StringListTrait
- createNode() - Method in class software.amazon.smithy.model.traits.StringTrait
- createNode() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- createNode() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- createNode(String, InputStream) - Method in class software.amazon.smithy.model.node.DefaultNodeFactory
-
Deprecated.
- createNode(String, String) - Method in class software.amazon.smithy.model.node.DefaultNodeFactory
-
Deprecated.
- createNode(String, String) - Method in interface software.amazon.smithy.model.node.NodeFactory
-
Deprecated.Creates a
Node
from a documentString
. - createPathToInputMember(ToShapeId, String) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Creates a
Path
to an operation input member if it exists. - createPathToOutputMember(ToShapeId, String) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Creates a
Path
to an operation output member if it exists. - createResult(ValidatedResult<Model>) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
-
Creates a test case result from a test case and validated model.
- createServiceFactory() - Static method in interface software.amazon.smithy.model.traits.TraitFactory
-
Creates a TraitFactory that discovers TraitService providers using the the Thread context class loader.
- createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.model.traits.TraitFactory
-
Creates a TraitFactory that discovers TraitService providers using the given ClassLoader.
- createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.model.validation.ValidatorFactory
-
Creates a ValidatorFactory that discovers service providers using the given ClassLoader.
- createServiceFactory(Iterable<TraitService>) - Static method in interface software.amazon.smithy.model.traits.TraitFactory
-
Creates a TraitFactory that uses a List of TraitService provider instances.
- createServiceFactory(Iterable<Validator>, Iterable<ValidatorService>) - Static method in interface software.amazon.smithy.model.validation.ValidatorFactory
-
Creates a ValidatorFactory that uses a collection of built-in validators and a collection of ValidatorService instances for configurable validators.
- createSmithyJarManifestUrl(String) - Static method in class software.amazon.smithy.model.loader.ModelDiscovery
-
Creates a URL that points to the Smithy manifest file of a JAR.
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.BooleanTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.CorsTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.DeprecatedTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.EndpointTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.EnumTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.HttpErrorTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.HttpTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.IdRefTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.LengthTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.ProtocolsTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.RangeTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.RetryableTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.StreamingTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.StringListTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.StringTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Provider
- createTrait(ShapeId, Node) - Method in interface software.amazon.smithy.model.traits.TraitService
-
Creates the trait from a node value.
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Provider
- createTrait(ShapeId, ShapeId, Node) - Method in interface software.amazon.smithy.model.traits.TraitFactory
-
Creates and configures a trait using model trait data.
- createValidator(String, ObjectNode) - Method in interface software.amazon.smithy.model.validation.ValidatorFactory
-
Creates and configures a Validator by name.
- createValidator(ObjectNode) - Method in interface software.amazon.smithy.model.validation.ValidatorService
-
Creates a validator using configuration.
- createValidator(ObjectNode) - Method in class software.amazon.smithy.model.validation.ValidatorService.Provider
- createWithPlugins(List<ModelTransformerPlugin>) - Static method in class software.amazon.smithy.model.transform.ModelTransformer
-
Creates a ModelTransformer using a list of ModelTransformer plugins.
- createWithServiceProviders(ClassLoader) - Static method in class software.amazon.smithy.model.transform.ModelTransformer
-
Creates a ModelTransformer that finds
ModelTransformerPlugin
service providers using the givenClassLoader
.
D
- danger(Shape, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- danger(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- DANGER - software.amazon.smithy.model.validation.Severity
- DATE_TIME - software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- DATE_TIME - Static variable in class software.amazon.smithy.model.traits.TimestampFormatTrait
- Default() - Constructor for class software.amazon.smithy.model.node.NodeVisitor.Default
- Default() - Constructor for class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- DefaultNodeFactory - Class in software.amazon.smithy.model.node
-
Deprecated.
- DefaultNodeFactory() - Constructor for class software.amazon.smithy.model.node.DefaultNodeFactory
-
Deprecated.
- defaultParameterizedTestSource(Class<?>) - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Factory method used to easily created a JUnit 5
ParameterizedTest
MethodSource
based on the givenClass
. - delete(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- DELETE - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the delete lifecycle operation.
- DeprecatedTrait - Class in software.amazon.smithy.model.traits
-
Marks a shape as deprecated.
- DeprecatedTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create a DeprecatedTrait.
- DeprecatedTrait.Provider - Class in software.amazon.smithy.model.traits
- DeprecatedTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Emits a validation event if a model contains shapes that are bound to deprecated traits.
- DeprecatedTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.DeprecatedTraitValidator
- determineRequestContentType(ToShapeId, String) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns the expected request Content-Type of the given operation.
- determineResponseContentType(ToShapeId, String) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns the expected response Content-Type of the given operation or error.
- determineTimestampFormat(ToShapeId, HttpBinding.Location, TimestampFormatTrait.Format) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Determines the appropriate timestamp format for a member shape bound to a specific location.
- determineValidatorName(Class<?>) - Static method in interface software.amazon.smithy.model.validation.ValidatorService
-
Determines the name of a validator based on a class name.
- diff(ToNode, ToNode) - Static method in class software.amazon.smithy.model.node.Node
-
Computes the differences between two Nodes as a String.
- DIRECTED - software.amazon.smithy.model.neighbor.RelationshipDirection
-
A directed relationship that goes from a shape to a shape that it references.
- DISABLE_JAR_CACHE - Static variable in class software.amazon.smithy.model.loader.ModelAssembler
-
Sets
URLConnection.setUseCaches(boolean)
to false. - disablePrelude() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Disables automatically loading the prelude models.
- discoverModels() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Discovers models by merging in all models returns by
ModelDiscovery
manifests using the thread contextClassLoader
. - discoverModels(ClassLoader) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Discovers models by merging in all models returns by
ModelDiscovery
manifests using the providedClassLoader
. - DOCUMENT - software.amazon.smithy.model.knowledge.HttpBinding.Location
- DOCUMENT - software.amazon.smithy.model.shapes.ShapeType
- documentation(String) - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- documentation(String) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- DOCUMENTATION - Static variable in class software.amazon.smithy.model.traits.EnumConstantBody
- DocumentationTrait - Class in software.amazon.smithy.model.traits
-
Adds documentation to a model.
- DocumentationTrait(String) - Constructor for class software.amazon.smithy.model.traits.DocumentationTrait
- DocumentationTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.DocumentationTrait
- DocumentationTrait.Provider - Class in software.amazon.smithy.model.traits
- documentShape(DocumentShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- documentShape(DocumentShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- documentShape(DocumentShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- DocumentShape - Class in software.amazon.smithy.model.shapes
-
Represents a
document
shape. - DocumentShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
DocumentShape
. - DOUBLE - software.amazon.smithy.model.shapes.ShapeType
- doubleShape(DoubleShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- doubleShape(DoubleShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- doubleShape(DoubleShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- DoubleShape - Class in software.amazon.smithy.model.shapes
-
Represents a
double
shape. - DoubleShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
DoubleShape
. - DynamicTrait - Class in software.amazon.smithy.model.traits
-
A general-purpose trait used to represent traits that are defined in the model and have no concrete implementation.
- DynamicTrait(ShapeId, Node) - Constructor for class software.amazon.smithy.model.traits.DynamicTrait
E
- EffectiveTraitQuery - Class in software.amazon.smithy.model.traits
-
Queries a shape index for effective traits bound to shapes and members.
- EffectiveTraitQuery.Builder - Class in software.amazon.smithy.model.traits
-
Builds a reusable EffectiveTraitQuery.
- empty() - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Creates an empty ValidatedResult with no value and no events.
- EndpointTrait - Class in software.amazon.smithy.model.traits
-
Defines custom endpoint bindings of an operation.
- EndpointTrait.Builder - Class in software.amazon.smithy.model.traits
- EndpointTrait.Provider - Class in software.amazon.smithy.model.traits
- EntityShape - Class in software.amazon.smithy.model.shapes
-
Abstract class representing service and resource shapes.
- EntityShape.Builder<B extends EntityShape.Builder,S extends EntityShape> - Class in software.amazon.smithy.model.shapes
-
Builder used to create a Service or Resource shape.
- EnumConstantBody - Class in software.amazon.smithy.model.traits
-
An enum definition for the enum trait.
- EnumConstantBody.Builder - Class in software.amazon.smithy.model.traits
-
Builds a
EnumConstantBody
. - EnumTrait - Class in software.amazon.smithy.model.traits
-
Constrains string values to one of the predefined enum constants.
- EnumTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create the enum trait.
- EnumTrait.Provider - Class in software.amazon.smithy.model.traits
- EnumTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that enum traits are valid.
- EnumTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.EnumTraitValidator
- EPOCH_SECONDS - software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- EPOCH_SECONDS - software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Requires that the value provided for all timestamp shapes is a unix timestamp.
- EPOCH_SECONDS - Static variable in class software.amazon.smithy.model.traits.TimestampFormatTrait
- equals(Object) - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
- equals(Object) - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- equals(Object) - Method in class software.amazon.smithy.model.Model
- equals(Object) - Method in class software.amazon.smithy.model.neighbor.Relationship
- equals(Object) - Method in class software.amazon.smithy.model.node.ArrayNode
- equals(Object) - Method in class software.amazon.smithy.model.node.BooleanNode
- equals(Object) - Method in class software.amazon.smithy.model.node.NullNode
- equals(Object) - Method in class software.amazon.smithy.model.node.NumberNode
- equals(Object) - Method in class software.amazon.smithy.model.node.ObjectNode
- equals(Object) - Method in class software.amazon.smithy.model.node.StringNode
- equals(Object) - Method in class software.amazon.smithy.model.pattern.Pattern
- equals(Object) - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
- equals(Object) - Method in class software.amazon.smithy.model.pattern.UriPattern
- equals(Object) - Method in class software.amazon.smithy.model.shapes.CollectionShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.EntityShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.MapShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.MemberShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.OperationShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.ResourceShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.ServiceShape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.Shape
- equals(Object) - Method in class software.amazon.smithy.model.shapes.ShapeId
- equals(Object) - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.
- equals(Object) - Method in class software.amazon.smithy.model.SourceLocation
- equals(Object) - Method in class software.amazon.smithy.model.traits.AbstractTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- equals(Object) - Method in class software.amazon.smithy.model.traits.Protocol
- equals(Object) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- equals(Object) - Method in class software.amazon.smithy.model.validation.ValidationEvent
- error(Shape, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- error(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- ERROR - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - ERROR - software.amazon.smithy.model.validation.Severity
- errorMessage(String) - Method in class software.amazon.smithy.model.traits.IdRefTrait.Builder
- errors(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Sets and replaces the errors of the operation.
- ErrorTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a structure can be used as an error.
- ErrorTrait(String) - Constructor for class software.amazon.smithy.model.traits.ErrorTrait
- ErrorTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.ErrorTrait
- ErrorTrait.Provider - Class in software.amazon.smithy.model.traits
- EventHeaderTrait - Class in software.amazon.smithy.model.traits
-
Marks a structure member of an event as an event header.
- EventHeaderTrait() - Constructor for class software.amazon.smithy.model.traits.EventHeaderTrait
- EventHeaderTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.EventHeaderTrait
- EventHeaderTrait.Provider - Class in software.amazon.smithy.model.traits
- eventId(String) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets an optional custom event ID to use for created validation events.
- eventId(String) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the required event ID of the event.
- EventPayloadTrait - Class in software.amazon.smithy.model.traits
-
Marks a structure member of an event as the event payload.
- EventPayloadTrait() - Constructor for class software.amazon.smithy.model.traits.EventPayloadTrait
- EventPayloadTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.EventPayloadTrait
- EventPayloadTrait.Provider - Class in software.amazon.smithy.model.traits
- EventPayloadTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that when an event structure contains an eventPayload member, that all other members are bound to headers.
- EventPayloadTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.EventPayloadTraitValidator
- eventShapeId(ShapeId) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets an optional shape ID that is used as the shape ID in each validation event emitted by the validator.
- EventStreamIndex - Class in software.amazon.smithy.model.knowledge
-
Index of operation shapes to event stream information.
- EventStreamIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.EventStreamIndex
- EventStreamInfo - Class in software.amazon.smithy.model.knowledge
-
Contains extracted event stream information.
- EventStreamTrait - Class in software.amazon.smithy.model.traits
- EventStreamTrait() - Constructor for class software.amazon.smithy.model.traits.EventStreamTrait
- EventStreamTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.EventStreamTrait
- EventStreamTrait.Provider - Class in software.amazon.smithy.model.traits
- EventStreamValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates inputEventStream and outputEventStream traits.
- EventStreamValidator() - Constructor for class software.amazon.smithy.model.validation.validators.EventStreamValidator
- ExamplesTrait - Class in software.amazon.smithy.model.traits
-
Defines examples for an operation.
- ExamplesTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builds and examples trait.
- ExamplesTrait.Example - Class in software.amazon.smithy.model.traits
-
A specific example.
- ExamplesTrait.Example.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create
ExamplesTrait.Example
s. - ExamplesTrait.Provider - Class in software.amazon.smithy.model.traits
- ExamplesTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that examples traits are valid for their operations.
- ExamplesTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ExamplesTraitValidator
- ExclusiveStructureMemberTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates traits that can only be applied to a single structure member.
- ExclusiveStructureMemberTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ExclusiveStructureMemberTraitValidator
- expectArrayMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be an array.
- expectArrayNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to an
ArrayNode
. - expectArrayNode(String) - Method in class software.amazon.smithy.model.node.ArrayNode
- expectArrayNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to an
ArrayNode
, throwingExpectationNotMetException
when the node is the wrong type. - ExpectationNotMetException - Exception in software.amazon.smithy.model.node
-
Thrown by
Node
methods that expect a node to be of a particular type or to have a particular member. - ExpectationNotMetException(String, FromSourceLocation) - Constructor for exception software.amazon.smithy.model.node.ExpectationNotMetException
- expectBooleanMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be a boolean.
- expectBooleanNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
BooleanNode
. - expectBooleanNode(String) - Method in class software.amazon.smithy.model.node.BooleanNode
- expectBooleanNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
BooleanNode
, throwingExpectationNotMetException
when the node is the wrong type. - expectMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name.
- expectMember(String, String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, throwing
ExpectationNotMetException
when the member is not present. - expectNeighborShape() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the neighbor shape or throws if it doesn't exist.
- expectNoAdditionalProperties(Collection<String>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Ensures that there are no additional properties other than the provided member names.
- expectNullMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be a null.
- expectNullNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
NullNode
. - expectNullNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
NullNode
, throwingExpectationNotMetException
when the node is the wrong type. - expectNullNode(String) - Method in class software.amazon.smithy.model.node.NullNode
- expectNumberMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be a number.
- expectNumberNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
NumberNode
. - expectNumberNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
NumberNode
, throwingExpectationNotMetException
when the node is the wrong type. - expectNumberNode(String) - Method in class software.amazon.smithy.model.node.NumberNode
- expectObjectMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be an object.
- expectObjectNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to an
ObjectNode
. - expectObjectNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to an
ObjectNode
, throwingExpectationNotMetException
when the node is the wrong type. - expectObjectNode(String) - Method in class software.amazon.smithy.model.node.ObjectNode
- expectOneOf(String...) - Method in class software.amazon.smithy.model.node.StringNode
-
Gets the string if it is one of the provided valid strings.
- expectOneOf(Collection<String>) - Method in class software.amazon.smithy.model.node.StringNode
-
Gets the string if it is one of the provided valid strings.
- expectShape(ShapeId) - Method in class software.amazon.smithy.model.Model
- expectShape(ShapeId, Class<T>) - Method in class software.amazon.smithy.model.Model
- expectShapeId() - Method in class software.amazon.smithy.model.node.StringNode
-
Expects that the value of the string is a fully-qualified Shape ID.
- expectShapeId(String) - Method in class software.amazon.smithy.model.node.StringNode
-
Expects that the value of the string is a Shape ID.
- expectStringMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a member and requires it to be a string.
- expectStringNode() - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
StringNode
. - expectStringNode(String) - Method in class software.amazon.smithy.model.node.Node
-
Casts the current node to a
StringNode
, throwingExpectationNotMetException
when the node is the wrong type. - expectStringNode(String) - Method in class software.amazon.smithy.model.node.StringNode
- expectTrait(Class<T>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets specific
Trait
by class from the shape or throws if not found. - ExternalDocumentationTrait - Class in software.amazon.smithy.model.traits
-
Provides a link to external documentation of a service or operation.
- ExternalDocumentationTrait(String) - Constructor for class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- ExternalDocumentationTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- ExternalDocumentationTrait.Provider - Class in software.amazon.smithy.model.traits
F
- failWhenMissing() - Method in class software.amazon.smithy.model.traits.IdRefTrait
- failWhenMissing(boolean) - Method in class software.amazon.smithy.model.traits.IdRefTrait.Builder
- filterMetadata(Model, BiPredicate<String, Node>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Filters out metadata key-value pairs from a model that do not match a predicate.
- filterShapes(Model, Predicate<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Filters shapes out of the model that do not match the given predicate.
- filterTraits(Model, BiPredicate<Shape, Trait>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Filters traits out of the model that do not match the given predicate.
- findDuplicateShapeNames(Collection<T>) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
-
Find shape IDs in a collection that do not have case-insensitively unique member names.
- findMemberTrait(Model, String) - Method in class software.amazon.smithy.model.shapes.MemberShape
- findMemberTrait(Model, String) - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets a trait from the member shape or from the shape targeted by the member.
- findMemberTrait(ShapeIndex, String) - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Deprecated.
- findMemberTrait(ShapeIndex, String) - Method in class software.amazon.smithy.model.shapes.Shape
-
Deprecated.
- findModels() - Static method in class software.amazon.smithy.model.loader.ModelDiscovery
-
Finds Smithy models using the thread context
ClassLoader
. - findModels(ClassLoader) - Static method in class software.amazon.smithy.model.loader.ModelDiscovery
-
Finds Smithy models using the given
ClassLoader
. - findModels(URL) - Static method in class software.amazon.smithy.model.loader.ModelDiscovery
-
Parse the Smithy models from the given URL that points to a Smithy manifest file in a JAR.
- findTrait(String) - Method in class software.amazon.smithy.model.shapes.Shape
-
Attempts to find a trait applied to the shape by ID.
- findTrait(ShapeId) - Method in class software.amazon.smithy.model.shapes.Shape
-
Attempts to find a trait applied to the shape by name.
- flatMapStream(S, Class<T>) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Used in a stream flatMapStream to return a
Stream
with aPair
of Shape and Trait if the trait is present on the given shape. - FLOAT - software.amazon.smithy.model.shapes.ShapeType
- floatShape(FloatShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- floatShape(FloatShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- floatShape(FloatShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- FloatShape - Class in software.amazon.smithy.model.shapes
-
Represents a
integer
shape. - FloatShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
FloatShape
. - format(ValidationEvent) - Method in class software.amazon.smithy.model.validation.ContextualValidationEventFormatter
- format(ValidationEvent) - Method in class software.amazon.smithy.model.validation.LineValidationEventFormatter
- format(ValidationEvent) - Method in interface software.amazon.smithy.model.validation.ValidationEventFormatter
-
Converts the event to a string.
- FORMAT - software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Validates timestamps by requiring that the value uses matches the resolved timestamp format, or is a unix timestamp or integer in the case that a member or shape does not have a
timestampFormat
trait. - from(boolean) - Static method in class software.amazon.smithy.model.node.Node
-
Create a
BooleanNode
from a boolean value. - from(Number) - Static method in class software.amazon.smithy.model.node.Node
-
Create a
NumberNode
from a Number value. - from(String) - Static method in class software.amazon.smithy.model.node.Node
-
Create a
StringNode
from a String value. - from(String) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates an absolute shape ID from the given string.
- fromErrors(Collection<ValidationEvent>) - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Creates a new ValidatedResult with no values and a list of
ValidationEvent
s. - fromModelFile(String) - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
-
Creates a test case from a model file.
- fromNodes(List<Node>) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ArrayNode
from a Collection of Node values. - fromNodes(Node...) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ArrayNode
from a variadic list of Node values. - fromOptionalNamespace(String, String) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Builds a
Id
from the given reference. - fromParts(String, String) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates an absolute shape ID from parts of a shape ID.
- fromParts(String, String, String) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates an absolute shape ID from parts of a shape ID.
- fromRelative(String, String) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Builds a
Id
from a relative shape reference. - fromSourceException(SourceException) - Static method in class software.amazon.smithy.model.validation.ValidationEvent
-
Creates a new ValidationEvent from a
SourceException
. - fromSourceException(SourceException, String) - Static method in class software.amazon.smithy.model.validation.ValidationEvent
-
Creates a new ValidationEvent from a
SourceException
. - FromSourceLocation - Interface in software.amazon.smithy.model
-
A value that can be traced back to a
SourceLocation
. - fromString(String) - Static method in enum software.amazon.smithy.model.shapes.ShapeType
-
Create a new Shape.Type from a string.
- fromString(String) - Static method in enum software.amazon.smithy.model.traits.TimestampFormatTrait.Format
-
Create a
Format
from a string that would appear in a model. - fromString(String) - Static method in enum software.amazon.smithy.model.validation.Severity
-
Create a new Severity from a string.
- fromStringMap(Map<String, String>) - Static method in class software.amazon.smithy.model.node.ObjectNode
- fromStrings(String...) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ArrayNode
from a variadic list of String values. - fromStrings(Collection<String>) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ArrayNode
from a Collection of String values. - fromValue(T) - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Creates a new ValidatedResult with a value and no
ValidationEvent
s.
G
- get(int) - Method in class software.amazon.smithy.model.node.ArrayNode
-
Gets a node from the given index.
- get(int) - Method in class software.amazon.smithy.model.selector.PathFinder.Path
- getAdditionalAllowedHeaders() - Method in class software.amazon.smithy.model.traits.CorsTrait
- getAdditionalExposedHeaders() - Method in class software.amazon.smithy.model.traits.CorsTrait
- getAllAuthSchemes() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
-
Gets a set of all the authentication schemes listed in each protocol.
- getAllOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape
-
Get all operations directly bound to this shape.
- getAllOperations() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- getAllParents(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.BottomUpIndex
-
Gets all of the parents of an operation or resource within a service.
- getAllTraits() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets all of the traits attached to the shape.
- getArrayMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be an array.
- getAuth() - Method in class software.amazon.smithy.model.traits.Protocol
-
Gets the ordered list of auth schemes supported by the protocol.
- getBindingTrait() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getBooleanMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a boolean.
- getBooleanMemberOrDefault(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a boolean, otherwise returns false.
- getBooleanMemberOrDefault(String, Boolean) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a boolean, otherwise returns a default value.
- getCode() - Method in class software.amazon.smithy.model.traits.HttpErrorTrait
- getCode() - Method in class software.amazon.smithy.model.traits.HttpTrait
- getCollectionOperations() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the operations bound through the "collectionOperations" property.
- getColumn() - Method in class software.amazon.smithy.model.SourceLocation
- getConflictingLabelSegments(UriPattern) - Method in class software.amazon.smithy.model.pattern.UriPattern
-
Gets a list of explicitly conflicting uri label segments between this pattern and another.
- getConflicts() - Method in class software.amazon.smithy.model.traits.TraitDefinition
-
Gets the trait names that conflict with this trait.
- getContainedOperations(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.TopDownIndex
-
Get all operations in service or resource closure.
- getContainedResources(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.TopDownIndex
-
Get all resources in a service or resource closure.
- getContainer() - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Gets the shape in which the member is contained.
- getContent() - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
-
Get the content of the segment.
- getCreate() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the create lifecycle operation of the resource.
- getDefault(Node) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
-
Returns a default value for any unhandled node.
- getDefault(Shape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
-
Returns a value for any unhandled shape.
- getDefaultHttpStatusCode() - Method in class software.amazon.smithy.model.traits.ErrorTrait
-
Returns the recommended default HTTP status code of the error.
- getDefaultServiceSchemes(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.AuthIndex
-
Gets the default authentication schemes supported by a service or the entire list of all auth schemes if no auth trait is set on the service shape in priority order.
- getDelete() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the delete lifecycle operation of the resource.
- getDirection() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the direction of the relationship.
- getDirection() - Method in enum software.amazon.smithy.model.neighbor.RelationshipType
-
Gets the direction of the relationship.
- getDocumentation() - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- getDocumentation() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getElements() - Method in class software.amazon.smithy.model.node.ArrayNode
-
Gets the list of nodes.
- getElementsAs(Class<T>) - Method in class software.amazon.smithy.model.node.ArrayNode
-
Gets the elements of the array as a list of a specific type of
Node
. - getElementsAs(Function<K, T>) - Method in class software.amazon.smithy.model.node.ArrayNode
-
Gets the elements of the ArrayNode as a specific type by applying a mapping function to each node.
- getEndShape() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
-
Gets the ending shape of the
Path
that matched the selector and is connected to the starting shape. - getEntityBinding(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.BottomUpIndex
-
Gets the direct parent of an operation or resource.
- getErrorMessage() - Method in class software.amazon.smithy.model.traits.IdRefTrait
- getErrors() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets a list of the error shape IDs that can be encountered.
- getErrors(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
- getEventId() - Method in class software.amazon.smithy.model.validation.ValidationEvent
-
Returns the identifier of the validation event.
- getEvents() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets all of the event stream events of the event stream.
- getEventStreamMember() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the top-level input or output member that targets the event stream.
- getEventStreamTarget() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the shape that is streamed over the event stream.
- getEventStreamTrait() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the event stream trait.
- getExamples() - Method in class software.amazon.smithy.model.traits.ExamplesTrait
- getExpectedEvents() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
-
Gets the expected validation events.
- getExtraEvents() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
- getFailedResults() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Result
- getFilename() - Method in class software.amazon.smithy.model.SourceLocation
- getFormat() - Method in class software.amazon.smithy.model.traits.TimestampFormatTrait
-
Gets the
timestampFormat
value as aFormat
enum. - getGreedyLabel() - Method in class software.amazon.smithy.model.pattern.Pattern
-
Gets the greedy label of the pattern, if present.
- getHostPrefix() - Method in class software.amazon.smithy.model.traits.EndpointTrait
- getId() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Gets the shape ID of the builder.
- getId() - Method in class software.amazon.smithy.model.shapes.Shape
-
Get the
ShapeId
of the shape. - getIdentifiers() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the identifiers of the resource.
- getIdiomaticTraitName(String) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Gets the idiomatic name of a prelude trait by stripping off the smithy.api# prefix.
- getIdiomaticTraitName(ToShapeId) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Gets the idiomatic name of a prelude trait by stripping off the smithy.api# prefix.
- getIds() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- getInitialMessageMembers() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the initial message members that form the initial-request or initial-response of the event stream.
- getInitialMessageTargets() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the shapes targeted by the initial message members that are not the target of an event stream.
- getInput() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getInput() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets the optional shape ID of the input of the operation.
- getInput() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getInput(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
- getInputInfo(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.EventStreamIndex
-
Get event stream information for the input of an operation.
- getInputToken() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getInputTokenMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getItems() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getItemsMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getKey() - Method in class software.amazon.smithy.model.shapes.MapShape
-
Get the key member shape of the map.
- getKnowledge(Class<T>) - Method in class software.amazon.smithy.model.Model
-
Gets a computed knowledge index of a specific type for the model.
- getLabel(String) - Method in class software.amazon.smithy.model.pattern.Pattern
-
Get a label by case-insensitive name.
- getLabels() - Method in class software.amazon.smithy.model.pattern.Pattern
-
Get a list of all segments that are labels.
- getLine() - Method in class software.amazon.smithy.model.SourceLocation
- getList() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the list lifecycle operation of the resource.
- getLocation() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getLocationName() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getMax() - Method in class software.amazon.smithy.model.traits.LengthTrait
-
Gets the max value.
- getMax() - Method in class software.amazon.smithy.model.traits.RangeTrait
-
Gets the max value.
- getMaxAge() - Method in class software.amazon.smithy.model.traits.CorsTrait
- getMember() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getMember() - Method in class software.amazon.smithy.model.shapes.CollectionShape
-
Get the member shape of the collection.
- getMember() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Gets the optional member of the shape.
- getMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name.
- getMemberName() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getMemberName() - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Get the member name of the member.
- getMembers() - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the map of members.
- getMembersByPrefix(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets a map of all members where the key starts with the given prefix.
- getMemberTrait(Model, Class<T>) - Method in class software.amazon.smithy.model.shapes.MemberShape
- getMemberTrait(Model, Class<T>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets a trait from the member shape or from the shape targeted by the member.
- getMemberTrait(ShapeIndex, Class<T>) - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Deprecated.
- getMemberTrait(ShapeIndex, Class<T>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Deprecated.
- getMessage() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait
-
Gets the deprecation message value.
- getMessage() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getMessageWithoutLocation() - Method in exception software.amazon.smithy.model.SourceException
-
Retrieves the message for this exception without the appended source location.
- getMetadata() - Method in class software.amazon.smithy.model.Model
- getMetadataProperty(String) - Method in class software.amazon.smithy.model.Model
-
Gets a metadata property by namespace and name.
- getMethod() - Method in class software.amazon.smithy.model.traits.HttpTrait
- getMin() - Method in class software.amazon.smithy.model.traits.LengthTrait
-
Gets the min value.
- getMin() - Method in class software.amazon.smithy.model.traits.RangeTrait
-
Gets the min value.
- getModelLocation() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
-
Gets the location of the model file.
- getModelLocation() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
- getModelWithoutTraitShapes(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Gets all shapes from a model where shapes that define traits or shapes that are only used as part of a trait definition have been removed.
- getName() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Get the name of the shape.
- getName() - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- getName() - Method in class software.amazon.smithy.model.traits.Protocol
-
Gets the protocol name.
- getName() - Method in class software.amazon.smithy.model.validation.AbstractValidator
- getName() - Method in interface software.amazon.smithy.model.validation.ValidatorService
-
Gets the name of the validator.
- getName() - Method in class software.amazon.smithy.model.validation.ValidatorService.Provider
- getNamespace() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Get the namespace of the shape.
- getNamespaceNames() - Method in class software.amazon.smithy.model.validation.Suppression
- getNeighbors(Shape) - Method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Gets the neighbor relationships of a shape.
- getNeighborShape() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the optional neighbor shape; the neighbor shape may be empty when the neighbor shape id was not in the shape index.
- getNeighborShapeId() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the shape id of the neighbor shape.
- getNonTraitShapes(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Deprecated.
- getNumberMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a number.
- getNumberMemberOrDefault(String, Number) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a number, otherwise returns the default value.
- getObjectMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be an object.
- getOperation() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the operation associated with this data.
- getOperation() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getOperationBindings(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
-
Gets a map of identifier names to input member names that provide a value for that identifier.
- getOperationBindingType(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
-
Gets the identifier binding type of an operation to a resource.
- getOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape
-
Gets operations bound only through the "operations" property.
- getOperationSchemes(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.AuthIndex
-
Gets the effective authentication schemes of an operation bound to a service in priority order.
- getOperationSchemes(ToShapeId, ToShapeId, String) - Method in class software.amazon.smithy.model.knowledge.AuthIndex
-
Gets the effective authentication schemes of an operation bound to a service that are compatible with a specific protocol of the service in priority order.
- getOrigin() - Method in class software.amazon.smithy.model.traits.CorsTrait
- getOutput() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getOutput() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets the optional shape ID of the output of the operation.
- getOutput() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getOutput(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
- getOutputInfo(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.EventStreamIndex
-
Get event stream information for the output of an operation.
- getOutputToken() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getOutputTokenMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getPageSize() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getPageSizeMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getPaginatedTrait() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
-
Gets the paginated trait of the operation merged with the service.
- getPaginationInfo(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.PaginatedIndex
- getPattern() - Method in class software.amazon.smithy.model.traits.PatternTrait
-
Gets the regex pattern.
- getPrefix() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- getProtocol(String) - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
-
Gets a protocol by name.
- getProtocolNames() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
-
Gets the list of protocol names.
- getProtocols() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
-
Gets the list of protocols.
- getProvider() - Method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
-
Gets the precomputed neighbor provider.
- getPut() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the put lifecycle operation of the resource.
- getQueryLiterals() - Method in class software.amazon.smithy.model.pattern.UriPattern
-
Get an immutable map of query string literal key-value pairs.
- getQueryLiteralValue(String) - Method in class software.amazon.smithy.model.pattern.UriPattern
-
Gets a specific query string literal parameter value.
- getRead() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the read lifecycle operation of the resource.
- getReason() - Method in class software.amazon.smithy.model.validation.Suppression
- getReferences() - Method in class software.amazon.smithy.model.traits.ReferencesTrait
-
Gets the references.
- getRel() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- getRelationshipType() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the relationship type.
- getRequestBindings(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Gets the request bindings of an operation as a map of member name to the binding.
- getRequestBindings(ToShapeId, HttpBinding.Location) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Gets the request bindings of an operation as a map of member name to the binding for a specific location type.
- getRequiresLength() - Method in class software.amazon.smithy.model.traits.StreamingTrait
- getResource() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
-
Get the referenced shape.
- getResourceBinding(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.BottomUpIndex
-
Gets the direct parent resource of an operation or resource if and only if the given resource or operation is bound to a resource and not bound to a service.
- getResourceReferences(ShapeId) - Method in class software.amazon.smithy.model.traits.ReferencesTrait
-
Gets a list of all references to a particular shape.
- getResources() - Method in class software.amazon.smithy.model.shapes.EntityShape
- getResponseBindings(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Gets the computed HTTP message response bindings for an operation or structure with an error trait.
- getResponseBindings(ToShapeId, HttpBinding.Location) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Gets the computed HTTP message response bindings for an operation or structure with an error trait for a specific binding type.
- getResponseCode(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Gets the computed status code of an operation or error structure.
- getResult() - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Get the optional result.
- getReverseProvider() - Method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
-
Gets a reversed, bottom up neighbor provider.
- getSegments() - Method in class software.amazon.smithy.model.pattern.Pattern
-
Gets all segments, in order.
- getSelector() - Method in class software.amazon.smithy.model.traits.IdRefTrait
- getSelector() - Method in class software.amazon.smithy.model.traits.TraitDefinition
-
Gets the valid places in a model that this trait can be applied.
- getSelectorLabel() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the token that is used in
Selector
expressions when referring to the relationship or an emptyOptional
if this relationship is not used in a selector. - getSelectorLabel() - Method in enum software.amazon.smithy.model.neighbor.RelationshipType
-
Gets the token that is used in
Selector
expressions when referring to the relationship or an emptyOptional
if this relationship is not used directly in a selector. - getService() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getService() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
-
Get the service binding.
- getSeverity() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getShape() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the starting shape in the relationship.
- getShape(ShapeId) - Method in class software.amazon.smithy.model.Model
- getShape(ShapeId) - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.
- getShapeId() - Method in class software.amazon.smithy.model.traits.AbstractTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.CorsTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.EnumTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.IdRefTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.LengthTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.RangeTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.RetryableTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.StreamingTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.TraitDefinition.Provider
- getShapeId() - Method in interface software.amazon.smithy.model.traits.TraitService
- getShapeId() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getShapeIndex() - Method in class software.amazon.smithy.model.Model
-
Deprecated.
- getShapes() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
-
Gets a list of all shapes in the path including the starting shape all the way to the last shape.
- getShapes() - Method in class software.amazon.smithy.model.validation.Suppression
- getShapeType() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Gets the type of shape being built.
- getShapeType() - Method in class software.amazon.smithy.model.shapes.BigDecimalShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.BigIntegerShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.BlobShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.BooleanShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.ByteShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.DocumentShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.DoubleShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.FloatShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.IntegerShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.ListShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.LongShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.MemberShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.ShortShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.StringShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.StructureShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.TimestampShape.Builder
- getShapeType() - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- getSince() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait
-
Gets the deprecated since value.
- getSmithyModelPathFromJarUrl(URL) - Static method in class software.amazon.smithy.model.loader.ModelDiscovery
-
Extracts the relative name of a Smithy model from a URL that points to a Smithy model returned from
ModelDiscovery.findModels()
. - getSourceLocation() - Method in interface software.amazon.smithy.model.FromSourceLocation
-
Gets the source location of a value.
- getSourceLocation() - Method in class software.amazon.smithy.model.node.Node
- getSourceLocation() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
- getSourceLocation() - Method in class software.amazon.smithy.model.shapes.Shape
- getSourceLocation() - Method in exception software.amazon.smithy.model.SourceException
- getSourceLocation() - Method in class software.amazon.smithy.model.SourceLocation
- getSourceLocation() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- getSourceLocation() - Method in class software.amazon.smithy.model.traits.AbstractTraitBuilder
-
Gets the source location configured for the builder.
- getSourceLocation() - Method in class software.amazon.smithy.model.validation.Suppression
- getSourceLocation() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getStartShape() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
-
Gets the starting shape of the
Path
. - getStringMap() - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets an immutable
Map<String, Node>
that represents the ObjectNode. - getStringMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a string.
- getStringMemberOrDefault(String, String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the member with the given name, and if present, expects it to be a string, otherwise returns the default value.
- getStructure() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the input or output structure of the data.
- getSuccessCount() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Result
- getSuppressionReason() - Method in class software.amazon.smithy.model.validation.ValidationEvent
-
Get the reason that the event was suppressed.
- getTags() - Method in class software.amazon.smithy.model.shapes.Shape
- getTags() - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- getTags() - Method in class software.amazon.smithy.model.traits.Protocol
- getTarget() - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Get the targeted member shape ID.
- getThrottling() - Method in class software.amazon.smithy.model.traits.RetryableTrait
- getTitle() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getTrait(Class<T>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Attempt to retrieve a specific
Trait
by class from the shape. - getTraitDefinition(String) - Method in class software.amazon.smithy.model.Model
-
Gets the trait definition of a specific trait shape ID.
- getTraitDefinition(ToShapeId) - Method in class software.amazon.smithy.model.Model
-
Gets the trait definition of a specific trait shape ID.
- getTraitDefinitions() - Method in class software.amazon.smithy.model.Model
-
Returns are trait shapes in the model as a map of
Shape
objects to theirTraitDefinition
traits. - getTraitShapes() - Method in class software.amazon.smithy.model.Model
- getType() - Method in class software.amazon.smithy.model.node.ArrayNode
- getType() - Method in class software.amazon.smithy.model.node.BooleanNode
- getType() - Method in class software.amazon.smithy.model.node.Node
-
Gets the type of the node.
- getType() - Method in class software.amazon.smithy.model.node.NullNode
- getType() - Method in class software.amazon.smithy.model.node.NumberNode
- getType() - Method in class software.amazon.smithy.model.node.ObjectNode
- getType() - Method in class software.amazon.smithy.model.node.StringNode
- getType() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets the type of the shape.
- getUnmatchedEvents() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
- getUpdate() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the update lifecycle operation of the resource.
- getUri() - Method in class software.amazon.smithy.model.traits.HttpTrait
- getUri() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- getValidationEvents() - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Get the list of
ValidationEvent
s associated with the result. - getValidationEvents() - Method in exception software.amazon.smithy.model.validation.ValidatedResultException
- getValidationEvents(Severity) - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Get validation events of a particular severity.
- getValidatorIds() - Method in class software.amazon.smithy.model.validation.Suppression
- getValue() - Method in class software.amazon.smithy.model.node.BooleanNode
-
Gets the true or false value of the boolean node.
- getValue() - Method in class software.amazon.smithy.model.node.NumberNode
-
Gets the number value.
- getValue() - Method in class software.amazon.smithy.model.node.StringNode
-
Gets the string value.
- getValue() - Method in class software.amazon.smithy.model.shapes.MapShape
-
Get the value member shape of the map.
- getValue() - Method in class software.amazon.smithy.model.traits.StringTrait
- getValues() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Gets the enum value to body.
- getValues() - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Gets the values set in the builder.
- getValues() - Method in class software.amazon.smithy.model.traits.StringListTrait
- getVersion() - Method in class software.amazon.smithy.model.shapes.ServiceShape
- GREEDY_LABEL - software.amazon.smithy.model.pattern.Pattern.Segment.Type
H
- hashCode() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
- hashCode() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- hashCode() - Method in class software.amazon.smithy.model.Model
- hashCode() - Method in class software.amazon.smithy.model.neighbor.Relationship
- hashCode() - Method in class software.amazon.smithy.model.node.ArrayNode
- hashCode() - Method in class software.amazon.smithy.model.node.BooleanNode
- hashCode() - Method in class software.amazon.smithy.model.node.NullNode
- hashCode() - Method in class software.amazon.smithy.model.node.NumberNode
- hashCode() - Method in class software.amazon.smithy.model.node.ObjectNode
- hashCode() - Method in class software.amazon.smithy.model.node.StringNode
- hashCode() - Method in class software.amazon.smithy.model.pattern.Pattern
- hashCode() - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
- hashCode() - Method in class software.amazon.smithy.model.pattern.UriPattern
- hashCode() - Method in class software.amazon.smithy.model.shapes.Shape
- hashCode() - Method in class software.amazon.smithy.model.shapes.ShapeId
- hashCode() - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.
- hashCode() - Method in class software.amazon.smithy.model.SourceLocation
- hashCode() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- hashCode() - Method in class software.amazon.smithy.model.traits.Protocol
- hashCode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- hashCode() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- hasHttpRequestBindings(Shape) - Static method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns true if a shape has any HTTP request trait bindings.
- hasHttpResponseBindings(Shape) - Static method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns true if a shape has any HTTP response trait bindings.
- hasIdentifiers() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- hasInitialMessage() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Returns true if the event stream has an initial-message, meaning there are top-level members of the input or output of the operation that are not the event stream member.
- hasNames() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Checks if all of the constants of an enum define a name.
- hasProtocol(String) - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
-
Checks if the trait contains a protocol of the given name.
- hasTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Checks if the shape has a specific trait by class.
- hasTrait(String) - Method in class software.amazon.smithy.model.shapes.Shape
-
Checks if the shape has a specific trait by name.
- hasTrait(ShapeId) - Method in class software.amazon.smithy.model.shapes.Shape
-
Checks if the shape has a specific trait by name.
- HEADER - software.amazon.smithy.model.knowledge.HttpBinding.Location
- HostLabelTrait - Class in software.amazon.smithy.model.traits
-
Binds an input member to a label in the hostPrefix of an endpoint trait on an operation.
- HostLabelTrait() - Constructor for class software.amazon.smithy.model.traits.HostLabelTrait
- HostLabelTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HostLabelTrait
- HostLabelTrait.Provider - Class in software.amazon.smithy.model.traits
- HostLabelTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that hostLabel traits are applied correctly for operation inputs.
- HostLabelTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HostLabelTraitValidator
- hostPrefix(String) - Method in class software.amazon.smithy.model.traits.EndpointTrait.Builder
- HTTP_DATE - software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- HTTP_DATE - Static variable in class software.amazon.smithy.model.traits.TimestampFormatTrait
- HttpBinding - Class in software.amazon.smithy.model.knowledge
-
Defines an HTTP message member binding.
- HttpBinding.Location - Enum in software.amazon.smithy.model.knowledge
-
HTTP binding types.
- HttpBindingIndex - Class in software.amazon.smithy.model.knowledge
-
Computes and indexes the explicit and implicit HTTP bindings of a model.
- HttpBindingIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.HttpBindingIndex
- HttpBindingsMissingValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that if any operation in a service uses the http trait, then all operations use them.
- HttpBindingsMissingValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpBindingsMissingValidator
- HttpErrorTrait - Class in software.amazon.smithy.model.traits
-
Defines a custom HTTP status code for error structures.
- HttpErrorTrait(int) - Constructor for class software.amazon.smithy.model.traits.HttpErrorTrait
- HttpErrorTrait(int, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpErrorTrait
- HttpErrorTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpHeaderTrait - Class in software.amazon.smithy.model.traits
-
Binds a member to an HTTP header.
- HttpHeaderTrait(String) - Constructor for class software.amazon.smithy.model.traits.HttpHeaderTrait
- HttpHeaderTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpHeaderTrait
- HttpHeaderTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpHeaderTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that httpHeader traits are case-insensitively unique.
- HttpHeaderTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpHeaderTraitValidator
- HttpLabelTrait - Class in software.amazon.smithy.model.traits
-
Binds a member to a URI label of an input of an operation using the member name.
- HttpLabelTrait() - Constructor for class software.amazon.smithy.model.traits.HttpLabelTrait
- HttpLabelTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpLabelTrait
- HttpLabelTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpLabelTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that httpLabel traits are applied correctly for operation inputs.
- HttpLabelTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpLabelTraitValidator
- HttpMethodSemanticsValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that `http` traits applied to operation shapes use the most semantically appropriate HTTP method according to RFC 7231.
- HttpMethodSemanticsValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpMethodSemanticsValidator
- HttpPayloadTrait - Class in software.amazon.smithy.model.traits
-
Binds a single structure member to the payload of an HTTP request.
- HttpPayloadTrait() - Constructor for class software.amazon.smithy.model.traits.HttpPayloadTrait
- HttpPayloadTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpPayloadTrait
- HttpPayloadTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpPayloadValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that if a payload trait is present then all members of the input of an operation are bound to part of the message.
- HttpPayloadValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpPayloadValidator
- HttpPrefixHeadersTrait - Class in software.amazon.smithy.model.traits
-
Binds a map structure member to prefixed HTTP headers.
- HttpPrefixHeadersTrait(String) - Constructor for class software.amazon.smithy.model.traits.HttpPrefixHeadersTrait
- HttpPrefixHeadersTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpPrefixHeadersTrait
- HttpPrefixHeadersTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpPrefixHeadersTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that httpHeader traits do not case-insensitively start with an httpPrefixHeader on the same structure.
- HttpPrefixHeadersTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpPrefixHeadersTraitValidator
- HttpQueryTrait - Class in software.amazon.smithy.model.traits
-
Binds a member to an HTTP query string.
- HttpQueryTrait(String) - Constructor for class software.amazon.smithy.model.traits.HttpQueryTrait
- HttpQueryTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.HttpQueryTrait
- HttpQueryTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpQueryTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that httpQuery trait bindings are case-sensitively unique.
- HttpQueryTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpQueryTraitValidator
- HttpResponseCodeSemanticsValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that HTTP response codes are appropriate for operations and errors.
- HttpResponseCodeSemanticsValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpResponseCodeSemanticsValidator
- HttpTrait - Class in software.amazon.smithy.model.traits
-
Defines the HTTP request and response code bindings of an operation.
- HttpTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create an Http trait.
- HttpTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpUriConflictValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that no two URIs in a service conflict with each other.
- HttpUriConflictValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpUriConflictValidator
I
- id(String) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the shape ID of the shape.
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the shape ID of the shape.
- ID - Static variable in class software.amazon.smithy.model.traits.AuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.BoxTrait
- ID - Static variable in class software.amazon.smithy.model.traits.CorsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.DeprecatedTrait
- ID - Static variable in class software.amazon.smithy.model.traits.DocumentationTrait
- ID - Static variable in class software.amazon.smithy.model.traits.EndpointTrait
- ID - Static variable in class software.amazon.smithy.model.traits.EnumTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ErrorTrait
- ID - Static variable in class software.amazon.smithy.model.traits.EventHeaderTrait
- ID - Static variable in class software.amazon.smithy.model.traits.EventPayloadTrait
- ID - Static variable in class software.amazon.smithy.model.traits.EventStreamTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ExamplesTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HostLabelTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpErrorTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpHeaderTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpLabelTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpPayloadTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpPrefixHeadersTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpQueryTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpTrait
- ID - Static variable in class software.amazon.smithy.model.traits.IdempotencyTokenTrait
- ID - Static variable in class software.amazon.smithy.model.traits.IdempotentTrait
- ID - Static variable in class software.amazon.smithy.model.traits.IdRefTrait
- ID - Static variable in class software.amazon.smithy.model.traits.JsonNameTrait
- ID - Static variable in class software.amazon.smithy.model.traits.LengthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.MediaTypeTrait
- ID - Static variable in class software.amazon.smithy.model.traits.PaginatedTrait
- ID - Static variable in class software.amazon.smithy.model.traits.PatternTrait
- ID - Static variable in class software.amazon.smithy.model.traits.PrivateTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ProtocolsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.RangeTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ReadonlyTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ReferencesTrait
- ID - Static variable in class software.amazon.smithy.model.traits.RequiredTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ResourceIdentifierTrait
- ID - Static variable in class software.amazon.smithy.model.traits.RetryableTrait
- ID - Static variable in class software.amazon.smithy.model.traits.SensitiveTrait
- ID - Static variable in class software.amazon.smithy.model.traits.SinceTrait
- ID - Static variable in class software.amazon.smithy.model.traits.StreamingTrait
- ID - Static variable in class software.amazon.smithy.model.traits.TagsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.TimestampFormatTrait
- ID - Static variable in class software.amazon.smithy.model.traits.TitleTrait
- ID - Static variable in class software.amazon.smithy.model.traits.TraitDefinition
- ID - Static variable in class software.amazon.smithy.model.traits.UniqueItemsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.XmlAttributeTrait
- ID - Static variable in class software.amazon.smithy.model.traits.XmlFlattenedTrait
- ID - Static variable in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- ID - Static variable in class software.amazon.smithy.model.traits.XmlNameTrait
- IdempotencyTokenTrait - Class in software.amazon.smithy.model.traits
-
Defines an operation input member that is used to prevent replayed requests.
- IdempotencyTokenTrait() - Constructor for class software.amazon.smithy.model.traits.IdempotencyTokenTrait
- IdempotencyTokenTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.IdempotencyTokenTrait
- IdempotencyTokenTrait.Provider - Class in software.amazon.smithy.model.traits
- IdempotentTrait - Class in software.amazon.smithy.model.traits
-
Indicates that an operation is idempotent.
- IdempotentTrait() - Constructor for class software.amazon.smithy.model.traits.IdempotentTrait
- IdempotentTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.IdempotentTrait
- IdempotentTrait.Provider - Class in software.amazon.smithy.model.traits
- IDENTIFIER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a
member
and the shapes that are referenced by its identifiers property. - IdentifierBindingIndex - Class in software.amazon.smithy.model.knowledge
-
Index of operation shapes to the identifiers bound to the operation.
- IdentifierBindingIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
- IdentifierBindingIndex.BindingType - Enum in software.amazon.smithy.model.knowledge
- identifiers(Map<String, ShapeId>) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
-
Sets the resource identifiers map of identifier name to shape ID.
- IDENTITY - Static variable in interface software.amazon.smithy.model.selector.Selector
-
A selector that always returns all provided values.
- IdRefPlugin - Class in software.amazon.smithy.model.validation.node
-
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.
- IdRefPlugin() - Constructor for class software.amazon.smithy.model.validation.node.IdRefPlugin
- IdRefTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a string value must contain a valid shape ID.
- IdRefTrait.Builder - Class in software.amazon.smithy.model.traits
- IdRefTrait.Provider - Class in software.amazon.smithy.model.traits
- ids(Map<String, String>) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- index(ShapeIndex) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Deprecated.
- inheritFromContainer(boolean) - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
-
When testing member shapes, also checks the container of the member for the presence of a trait.
- input(ObjectNode) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- input(ToShapeId) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Sets the input shape ID of the operation.
- INPUT - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - inputToken(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- INSTANCE - software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Indicates that the operation is bound to a resource as an instance operation.
- INSTANCE_OPERATION - software.amazon.smithy.model.neighbor.RelationshipType
-
An instance operation relationship exists between a resource and the operations bound to the resource in the "Operations", "put", "read", "update", and "delete" properties.
- INTEGER - software.amazon.smithy.model.shapes.ShapeType
- integerShape(IntegerShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- integerShape(IntegerShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- integerShape(IntegerShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- IntegerShape - Class in software.amazon.smithy.model.shapes
-
Represents an
integer
shape. - IntegerShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
IntegerShape
. - InvalidPatternException - Exception in software.amazon.smithy.model.pattern
-
Exception thrown for invalid patterns.
- InvalidPatternException(String) - Constructor for exception software.amazon.smithy.model.pattern.InvalidPatternException
- InvalidUriPatternException - Exception in software.amazon.smithy.model.pattern
-
Exception thrown for invalid HTTP URI patterns.
- INVERTED - software.amazon.smithy.model.neighbor.RelationshipDirection
-
The relationship goes from a shape to the shape that defines a directed relationship to the shape.
- isArrayNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is an array type.
- isBigDecimalShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isBigIntegerShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isBlobShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isBooleanNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is a boolean type.
- isBooleanShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isBoxed(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.BoxIndex
-
Checks if the given shape should be considered boxed, meaning it accepts a null value.
- isBroken() - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Checks if the result has any error or danger events..
- isByteShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isClientError() - Method in class software.amazon.smithy.model.traits.ErrorTrait
- isDocumentShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isDoubleShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isEmpty() - Method in class software.amazon.smithy.model.node.ArrayNode
-
Returns true if the array node is empty.
- isEmpty() - Method in class software.amazon.smithy.model.node.ObjectNode
-
Returns true if this object has no members.
- isFloatingPointNumber() - Method in class software.amazon.smithy.model.node.NumberNode
-
Returns true if the node contains a floating point number.
- isFloatShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isGreedyLabel() - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
- isIntegerShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isInvalid() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
-
Checks if the result does not match expected results.
- isLabel() - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
- isListShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isLongShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isMapShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isMemberShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isNaturalNumber() - Method in class software.amazon.smithy.model.node.NumberNode
-
Returns true if the node contains a natural number.
- isNullNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is a null type.
- isNumberNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is a number type.
- isObjectNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is an object type.
- isOperationShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isOptional() - Method in class software.amazon.smithy.model.shapes.MemberShape
- isPreludeShape(ToShapeId) - Static method in class software.amazon.smithy.model.loader.Prelude
-
Checks if the given shape ID is defined by the prelude.
- isPublicPreludeShape(ToShapeId) - Static method in class software.amazon.smithy.model.loader.Prelude
-
Checks if the given shape is a public shape or trait defined by the prelude.
- isRequired() - Method in class software.amazon.smithy.model.shapes.MemberShape
- isResourceShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isServerError() - Method in class software.amazon.smithy.model.traits.ErrorTrait
- isServiceShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isSetShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isShortShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isSingleEvent() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Checks if this is a single-event event stream, meaning that only a single-event shape is streamed over the event stream zero or more times.
- isStringNode() - Method in class software.amazon.smithy.model.node.Node
-
Checks if this node is a string type.
- isStringShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isStructurallyExclusive() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- isStructureShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isTimestampShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isTraitApplied(ToShapeId) - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery
-
Checks if the trait is effectively applied to a shape.
- isUnionShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isValidIdentifier(CharSequence) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Checks if the given string is a valid identifier.
- isValidNamespace(CharSequence) - Static method in class software.amazon.smithy.model.shapes.ShapeId
-
Checks if the given string is a valid namespace.
- items(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- iterator() - Method in class software.amazon.smithy.model.node.ArrayNode
J
- JsonNameTrait - Class in software.amazon.smithy.model.traits
-
Provides a custom name to use when serializing a structure member name as a JSON object property.
- JsonNameTrait(String) - Constructor for class software.amazon.smithy.model.traits.JsonNameTrait
- JsonNameTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.JsonNameTrait
- JsonNameTrait.Provider - Class in software.amazon.smithy.model.traits
K
- key(MemberShape) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- key(ShapeId) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
-
Sets the key member of the map.
- key(ShapeId, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
-
Sets the key member of the map.
- KnowledgeIndex - Interface in software.amazon.smithy.model.knowledge
-
Contains an index of computed knowledge about a
Model
.
L
- LABEL - software.amazon.smithy.model.knowledge.HttpBinding.Location
- LABEL - software.amazon.smithy.model.pattern.Pattern.Segment.Type
- LengthTrait - Class in software.amazon.smithy.model.traits
-
Constrains a shape to minimum and maximum number of elements or size.
- LengthTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create a LongTrait.
- LengthTrait.Provider - Class in software.amazon.smithy.model.traits
- LengthTraitValidator - Class in software.amazon.smithy.model.validation.validators
- LengthTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.LengthTraitValidator
- LineValidationEventFormatter - Class in software.amazon.smithy.model.validation
-
Writes
ValidationEvent
objects as a single line string. - LineValidationEventFormatter() - Constructor for class software.amazon.smithy.model.validation.LineValidationEventFormatter
- list(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- LIST - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the list lifecycle operation.
- LIST - software.amazon.smithy.model.shapes.ShapeType
- LIST_MEMBER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
list
shapes to theirmember shapes
. - listShape(ListShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- listShape(ListShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- listShape(ListShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- ListShape - Class in software.amazon.smithy.model.shapes
-
Represents a
list
shape. - ListShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ListShape
. - LITERAL - software.amazon.smithy.model.pattern.Pattern.Segment.Type
- loadArrayOfString(String, Node) - Static method in class software.amazon.smithy.model.node.Node
-
Expects an array of strings and returns the loaded strings.
- loadBuiltinValidators() - Method in interface software.amazon.smithy.model.validation.ValidatorFactory
-
Returns a list of built-in validators that are always applied to a Model regardless of if they are explicitly configured in the metadata of a model.
- LONG - software.amazon.smithy.model.shapes.ShapeType
- longShape(LongShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- longShape(LongShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- longShape(LongShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- LongShape - Class in software.amazon.smithy.model.shapes
-
Represents a
integer
shape. - LongShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
LongShape
.
M
- makeAbsoluteName(String) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Makes the given trait name absolute if it is relative.
- makeAbsoluteName(String, String) - Static method in interface software.amazon.smithy.model.traits.Trait
-
Makes the given trait name absolute if it is relative.
- MAP - software.amazon.smithy.model.shapes.ShapeType
- MAP_KEY - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
map
shapes. - MAP_VALUE - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
map
shapes. - MapLengthPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the length trait on map shapes or members that target them.
- MapLengthPlugin() - Constructor for class software.amazon.smithy.model.validation.node.MapLengthPlugin
- mapShape(MapShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- mapShape(MapShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- mapShape(MapShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- MapShape - Class in software.amazon.smithy.model.shapes
-
Represents a
map
shape. - MapShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ListShape
. - mapShapes(Model, Function<Shape, Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Maps over all shapes in the model using a mapping function, allowing shapes to be replaced with completely different shapes or slightly modified shapes.
- mapShapes(Model, List<Function<Shape, Shape>>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Maps over all shapes in the model using multiple mapping functions.
- mapTraits(Model, BiFunction<Shape, Trait, Trait>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Maps over all traits in the model using a mapping function that accepts the shape the trait is applied to, a trait, and returns a trait, possibly even a different kind of trait.
- mapTraits(Model, List<BiFunction<Shape, Trait, Trait>>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Maps over all traits in the model using multiple mapping functions.
- max(Long) - Method in class software.amazon.smithy.model.traits.LengthTrait.Builder
- max(BigDecimal) - Method in class software.amazon.smithy.model.traits.RangeTrait.Builder
- maxAge(int) - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- MediaTypeTrait - Class in software.amazon.smithy.model.traits
-
Documents the media type of a blob shape.
- MediaTypeTrait(String) - Constructor for class software.amazon.smithy.model.traits.MediaTypeTrait
- MediaTypeTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.MediaTypeTrait
- MediaTypeTrait.Provider - Class in software.amazon.smithy.model.traits
- member(MemberShape) - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
-
Sets the member of the collection.
- member(ShapeId) - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
-
Sets the member of the collection.
- member(ShapeId, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
-
Sets the member of the collection.
- MEMBER - software.amazon.smithy.model.shapes.ShapeType
- MEMBER_CONTAINER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships exist on
member
shapes. - MEMBER_TARGET - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships exist on
member
shapes. - members() - Method in class software.amazon.smithy.model.shapes.CollectionShape
- members() - Method in class software.amazon.smithy.model.shapes.MapShape
- members() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets all of the members contained in the shape.
- memberShape(MemberShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- memberShape(MemberShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- memberShape(MemberShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- MemberShape - Class in software.amazon.smithy.model.shapes
-
Represents a member that targets another shape by ID.
- MemberShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
MemberShape
. - merge(ArrayNode) - Method in class software.amazon.smithy.model.node.ArrayNode
-
Merges two ArrayNodes into a new ArrayNode.
- merge(ObjectNode) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- merge(ObjectNode) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Merge this object node with another, creating a new ObjectNode.
- merge(PaginatedTrait) - Method in class software.amazon.smithy.model.traits.PaginatedTrait
-
Merges this paginated trait with another trait.
- message(String) - Method in class software.amazon.smithy.model.traits.DeprecatedTrait.Builder
- message(String) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the required message of the event.
- message(String, Object...) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
- metadata(Map<String, Node>) - Method in class software.amazon.smithy.model.Model.Builder
- metadataFilter(Predicate<String>) - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
-
Predicate that determines if a metadata is serialized.
- method(String) - Method in class software.amazon.smithy.model.traits.HttpTrait.Builder
- min(Long) - Method in class software.amazon.smithy.model.traits.LengthTrait.Builder
- min(BigDecimal) - Method in class software.amazon.smithy.model.traits.RangeTrait.Builder
- model(Model) - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
-
Sets the required model to query.
- model(Model) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets the required model to use when traversing walking shapes during validation.
- Model - Class in software.amazon.smithy.model
-
A Smithy model, including shapes, traits, custom traits, validators, suppressions and metadata.
- MODEL_ERROR - Static variable in interface software.amazon.smithy.model.validation.Validator
-
Event ID used for structural errors encountered when loading a model.
- MODEL_VERSION - Static variable in class software.amazon.smithy.model.Model
-
Specifies the highest supported version of the IDL.
- Model.Builder - Class in software.amazon.smithy.model
-
Builder used to create a Model.
- ModelAssembler - Class in software.amazon.smithy.model.loader
-
Assembles and validates a
Model
from documents, files, shapes, and other sources. - ModelAssembler() - Constructor for class software.amazon.smithy.model.loader.ModelAssembler
- ModelDiscovery - Class in software.amazon.smithy.model.loader
-
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 in software.amazon.smithy.model.loader
-
Exception thrown when a model fails to be imported.
- ModelImportException(String) - Constructor for exception software.amazon.smithy.model.loader.ModelImportException
- ModelImportException(String, Throwable) - Constructor for exception software.amazon.smithy.model.loader.ModelImportException
- ModelManifestException - Exception in software.amazon.smithy.model.loader
- ModelManifestException(String) - Constructor for exception software.amazon.smithy.model.loader.ModelManifestException
- ModelManifestException(String, Throwable) - Constructor for exception software.amazon.smithy.model.loader.ModelManifestException
- ModelSerializer - Class in software.amazon.smithy.model.shapes
-
Serializes a
Model
to anObjectNode
. - ModelSerializer.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create
ModelSerializer
. - ModelSyntaxException - Exception in software.amazon.smithy.model.loader
-
Thrown when the syntax of the IDL is invalid.
- ModelSyntaxException(String, int, int) - Constructor for exception software.amazon.smithy.model.loader.ModelSyntaxException
- ModelSyntaxException(String, FromSourceLocation) - Constructor for exception software.amazon.smithy.model.loader.ModelSyntaxException
- ModelTransformer - Class in software.amazon.smithy.model.transform
-
Class used to transform
Model
s. - ModelTransformerPlugin - Interface in software.amazon.smithy.model.transform
-
Plugin service used with ModelTransformer.
N
- name(String) - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- name(String) - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Sets the protocol name.
- NAME - Static variable in class software.amazon.smithy.model.traits.EnumConstantBody
- NAMESPACE - Static variable in class software.amazon.smithy.model.loader.Prelude
-
The Smithy prelude namespace.
- NeighborProvider - Interface in software.amazon.smithy.model.neighbor
-
Provides the neighbor relationships for a given shape.
- NeighborProviderIndex - Class in software.amazon.smithy.model.knowledge
-
Provides a cache of precomputed neighbors for models.
- NeighborProviderIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.NeighborProviderIndex
- Node - Class in software.amazon.smithy.model.node
-
Base class of for all Smithy model nodes.
- NodeFactory - Interface in software.amazon.smithy.model.node
-
Deprecated.
- NodeType - Enum in software.amazon.smithy.model.node
-
The set of possible node types.
- NodeValidationVisitor - Class in software.amazon.smithy.model.validation
- NodeValidationVisitor.Builder - Class in software.amazon.smithy.model.validation
-
Builds a
NodeValidationVisitor
. - NodeValidatorPlugin - Interface in software.amazon.smithy.model.validation.node
- NodeVisitor<R> - Interface in software.amazon.smithy.model.node
-
Node visitor interface.
- NodeVisitor.Default<R> - Class in software.amazon.smithy.model.node
-
Creates
NodeVisitor
that return a default value when necessary when visiting nodes. - none() - Static method in class software.amazon.smithy.model.SourceLocation
-
Creates an empty source location.
- NONE - software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Indicates that the operation is not bound to a resource.
- NONE - Static variable in class software.amazon.smithy.model.SourceLocation
- NONE_AUTH - Static variable in class software.amazon.smithy.model.traits.ProtocolsTrait
- note(Shape, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- note(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- NOTE - software.amazon.smithy.model.validation.Severity
- NULL - software.amazon.smithy.model.node.NodeType
- nullNode() - Static method in class software.amazon.smithy.model.node.Node
-
Creates a
NullNode
. - nullNode(NullNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- nullNode(NullNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits a null node.
- NullNode - Class in software.amazon.smithy.model.node
-
Represents a null node.
- NullNode(SourceLocation) - Constructor for class software.amazon.smithy.model.node.NullNode
- NUMBER - software.amazon.smithy.model.node.NodeType
- numberNode(NumberNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- numberNode(NumberNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits a number node.
- NumberNode - Class in software.amazon.smithy.model.node
-
Represents a number node.
- NumberNode(Number, SourceLocation) - Constructor for class software.amazon.smithy.model.node.NumberNode
- NumberShape - Class in software.amazon.smithy.model.shapes
-
Abstract class representing all numeric types.
O
- OBJECT - software.amazon.smithy.model.node.NodeType
- objectNode() - Static method in class software.amazon.smithy.model.node.Node
-
Creates an empty
ObjectNode
. - objectNode(Map<StringNode, Node>) - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ObjectNode
from the given map of Nodes. - objectNode(ObjectNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- objectNode(ObjectNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits an object node.
- ObjectNode - Class in software.amazon.smithy.model.node
-
Represents an object node.
- ObjectNode(Map<StringNode, Node>, SourceLocation) - Constructor for class software.amazon.smithy.model.node.ObjectNode
- ObjectNode.Builder - Class in software.amazon.smithy.model.node
-
Builder used to efficiently create an ObjectNode.
- objectNodeBuilder() - Static method in class software.amazon.smithy.model.node.Node
-
Creates an
ObjectNode.Builder
. - of(Model) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Creates a default NeighborProvider for the given model.
- of(ShapeIndex) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Deprecated.
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in interface software.amazon.smithy.model.transform.ModelTransformerPlugin
-
The method that is invoked each time shapes are removed from a model.
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.CleanBindings
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.CleanOperationStructures
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.CleanResourceReferences
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.CleanStructureAndUnionMembers
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.RemoveTraits
- OPERATION - software.amazon.smithy.model.neighbor.RelationshipType
-
An operation relationship exists between a service and the operations bound to the service in the "operations" property, and between a resource and the operations bound to the resource in the "operations", "collectionOperations", and lifecycle properties.
- OPERATION - software.amazon.smithy.model.shapes.ShapeType
- OperationIndex - Class in software.amazon.smithy.model.knowledge
-
Index of operation IDs to their resolved input, output, and error structures.
- OperationIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.OperationIndex
- operations(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- operationShape(OperationShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- operationShape(OperationShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- operationShape(OperationShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- OperationShape - Class in software.amazon.smithy.model.shapes
-
Represents an API operation.
- OperationShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
OperationShape
. - orderedTickedList(Collection<?>) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
-
Creates a comma separated string made up of the given collection.
- orElse(R) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
-
Return a value for all unhandled nodes.
- orElseGet(Function<Shape, R>) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
-
Register a case for unhandled shapes and builds the Cases.
- orElseGet(Supplier<R>) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
-
Register a case for unhandled shapes and builds the Cases.
- orElseThrow(RuntimeException) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
-
Register a case for unhandled shapes that throws an exception.
- origin(String) - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- output(ObjectNode) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- output(ToShapeId) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Sets the output shape ID of the operation.
- OUTPUT - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - outputToken(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
P
- pageSize(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- PaginatedIndex - Class in software.amazon.smithy.model.knowledge
-
Index of operation shapes to paginated trait information.
- PaginatedIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.PaginatedIndex
- PaginatedTrait - Class in software.amazon.smithy.model.traits
-
Defines the pagination functionality of an operation.
- PaginatedTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builds the paginated trait.
- PaginatedTrait.Provider - Class in software.amazon.smithy.model.traits
- PaginatedTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates paginated traits.
- PaginatedTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.PaginatedTraitValidator
- PaginationInfo - Class in software.amazon.smithy.model.knowledge
-
Resolved and valid pagination information about an operation in a service.
- parse(InputStream) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON input stream and returns a Node.
- parse(InputStream, String) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON input stream and returns a Node.
- parse(String) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON string and return a Node.
- parse(String) - Static method in class software.amazon.smithy.model.pattern.UriPattern
-
Parse a URI pattern string into a UriPattern.
- parse(String) - Static method in interface software.amazon.smithy.model.selector.Selector
-
Parses a selector expression.
- parse(String, int) - Static method in class software.amazon.smithy.model.pattern.Pattern.Segment
-
Parse a segment from the given offset.
- parse(String, String) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON string and File Name and return a Node.
- parseJsonWithComments(String) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON string and return a Node.
- parseJsonWithComments(String, String) - Static method in class software.amazon.smithy.model.node.Node
-
Attempts to parse the given JSON string and File Name and return a Node.
- Path(List<Relationship>) - Constructor for class software.amazon.smithy.model.selector.PathFinder.Path
- PathFinder - Class in software.amazon.smithy.model.selector
-
Finds the possible directed relationship paths from a starting shape to shapes connected to the starting shape that match a selector.
- PathFinder.Path - Class in software.amazon.smithy.model.selector
-
An immutable
Relationship
path from a starting shape to an end shape. - pattern(String) - Method in class software.amazon.smithy.model.pattern.Pattern.Builder
- Pattern - Class in software.amazon.smithy.model.pattern
-
Represents a contained pattern.
- Pattern(Pattern.Builder) - Constructor for class software.amazon.smithy.model.pattern.Pattern
- Pattern.Builder - Class in software.amazon.smithy.model.pattern
-
Builder used to create a Pattern.
- Pattern.Segment - Class in software.amazon.smithy.model.pattern
-
Segment within a Pattern.
- Pattern.Segment.Type - Enum in software.amazon.smithy.model.pattern
- PatternTrait - Class in software.amazon.smithy.model.traits
-
Restricts string values to a specified regular expression.
- PatternTrait(String) - Constructor for class software.amazon.smithy.model.traits.PatternTrait
- PatternTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.PatternTrait
- PatternTrait.Provider - Class in software.amazon.smithy.model.traits
- PatternTraitPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the pattern trait on string shapes or members that target them.
- PatternTraitPlugin() - Constructor for class software.amazon.smithy.model.validation.node.PatternTraitPlugin
- PAYLOAD - software.amazon.smithy.model.knowledge.HttpBinding.Location
- precomputed(Model) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Creates a NeighborProvider that precomputes the neighbors of a model.
- precomputed(Model, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Creates a NeighborProvider that precomputes the neighbors of a model.
- precomputed(ShapeIndex) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Deprecated.
- precomputed(ShapeIndex, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Deprecated.
- prefix(String) - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Builder
- PREFIX_HEADERS - software.amazon.smithy.model.knowledge.HttpBinding.Location
- Prelude - Class in software.amazon.smithy.model.loader
-
Represents the prelude model available to every Smithy model.
- prettyPrintJson(Node) - Static method in class software.amazon.smithy.model.node.Node
-
Writes the contents of a Node to a pretty-printed JSON string.
- printJson(Node) - Static method in class software.amazon.smithy.model.node.Node
-
Writes the contents of a Node to a non-pretty-printed JSON string.
- PrivateAccessValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that shapes in separate namespaces don't refer to shapes in other namespaces that are marked as private.
- PrivateAccessValidator() - Constructor for class software.amazon.smithy.model.validation.validators.PrivateAccessValidator
- PrivateTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a shape cannot be targeted outside of the namespace in which it was defined.
- PrivateTrait() - Constructor for class software.amazon.smithy.model.traits.PrivateTrait
- PrivateTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.PrivateTrait
- PrivateTrait.Provider - Class in software.amazon.smithy.model.traits
- Protocol - Class in software.amazon.smithy.model.traits
-
Represents a Smithy protocol.
- Protocol.Builder - Class in software.amazon.smithy.model.traits
-
Protocol builder.
- ProtocolsTrait - Class in software.amazon.smithy.model.traits
-
Defines the protocols supported by a service.
- ProtocolsTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builds the protocols trait.
- ProtocolsTrait.Provider - Class in software.amazon.smithy.model.traits
- Provider() - Constructor for class software.amazon.smithy.model.traits.AuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.BoxTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.CorsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.DeprecatedTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.DocumentationTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.EndpointTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.EnumTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ErrorTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.EventHeaderTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.EventPayloadTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.EventStreamTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ExternalDocumentationTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HostLabelTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpErrorTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpHeaderTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpLabelTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpPayloadTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpPrefixHeadersTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpQueryTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.IdempotencyTokenTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.IdempotentTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.IdRefTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.JsonNameTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.LengthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.MediaTypeTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.PaginatedTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.PatternTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.PrivateTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ProtocolsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.RangeTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ReadonlyTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ReferencesTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.RequiredTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ResourceIdentifierTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.RetryableTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.SensitiveTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.SinceTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.StreamingTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.TagsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.TimestampFormatTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.TitleTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.TraitDefinition.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.UniqueItemsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.XmlAttributeTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.XmlFlattenedTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.XmlNamespaceTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.XmlNameTrait.Provider
- Provider(Class<T>, Function<ObjectNode, T>) - Constructor for class software.amazon.smithy.model.validation.ValidatorService.Provider
- Provider(Class<T>, Supplier<T>) - Constructor for class software.amazon.smithy.model.validation.ValidatorService.Provider
- Provider(String, Function<ObjectNode, ? extends Validator>) - Constructor for class software.amazon.smithy.model.validation.ValidatorService.Provider
- Provider(ShapeId) - Constructor for class software.amazon.smithy.model.traits.AbstractTrait.Provider
- Provider(ShapeId, BiFunction<String, SourceLocation, T>) - Constructor for class software.amazon.smithy.model.traits.StringTrait.Provider
- Provider(ShapeId, BiFunction<List<String>, SourceLocation, T>) - Constructor for class software.amazon.smithy.model.traits.StringListTrait.Provider
- Provider(ShapeId, Function<SourceLocation, T>) - Constructor for class software.amazon.smithy.model.traits.BooleanTrait.Provider
- put(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- PUT - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the put lifecycle operation.
- putMetadata(String, Node) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds metadata to the model.
- putMetadataProperty(String, Node) - Method in class software.amazon.smithy.model.Model.Builder
- putProperty(String, Object) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Puts a configuration property on the ModelAssembler.
Q
- QUERY - software.amazon.smithy.model.knowledge.HttpBinding.Location
R
- RangeTrait - Class in software.amazon.smithy.model.traits
-
Constrains a shape to minimum and maximum numeric range.
- RangeTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create a LongTrait.
- RangeTrait.Provider - Class in software.amazon.smithy.model.traits
- RangeTraitPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the range trait on number shapes or members that target them.
- RangeTraitPlugin() - Constructor for class software.amazon.smithy.model.validation.node.RangeTraitPlugin
- RangeTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that range traits are valid.
- RangeTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.RangeTraitValidator
- read(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- READ - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the get lifecycle operation.
- ReadonlyTrait - Class in software.amazon.smithy.model.traits
-
Indicates that an operation is read-only.
- ReadonlyTrait() - Constructor for class software.amazon.smithy.model.traits.ReadonlyTrait
- ReadonlyTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.ReadonlyTrait
- ReadonlyTrait.Provider - Class in software.amazon.smithy.model.traits
- reason(String) - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- references(List<ReferencesTrait.Reference>) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- ReferencesTrait - Class in software.amazon.smithy.model.traits
-
Defines references to resources within a structure.
- ReferencesTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder use to create the references trait.
- ReferencesTrait.Provider - Class in software.amazon.smithy.model.traits
- ReferencesTrait.Reference - Class in software.amazon.smithy.model.traits
-
Reference to a resource.
- ReferencesTrait.Reference.Builder - Class in software.amazon.smithy.model.traits
-
Builder to create a
ReferencesTrait.Reference
. - ReferencesTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that references are correct.
- ReferencesTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ReferencesTraitValidator
- rel(String) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- Relationship - Class in software.amazon.smithy.model.neighbor
-
Represent a direct relationship between two shapes.
- RelationshipDirection - Enum in software.amazon.smithy.model.neighbor
-
Defines the directionality of a relationship.
- RelationshipType - Enum in software.amazon.smithy.model.neighbor
-
Defines the relationship types between neighboring shapes.
- removeAuth(String) - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Removes an auth scheme from the protocol.
- removeCollectionOperation(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- removeConflict(ToShapeId) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- removeEnum(String) - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
- removeError(ToShapeId) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Removes an error by Shape ID.
- removeFromAllOperationBindings(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
-
Removes an operation binding from lifecycles and the operations list.
- removeOperation(ToShapeId) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- removeProperty(String) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Removes a setting from the ModelAssembler.
- removeProtocol(String) - Method in class software.amazon.smithy.model.traits.ProtocolsTrait.Builder
-
Removes a protocol by name from the builder.
- removeResource(ToShapeId) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- removeShape(ShapeId) - Method in class software.amazon.smithy.model.Model.Builder
-
Removes a shape from the builder by ID.
- removeShape(ShapeId) - Method in class software.amazon.smithy.model.shapes.ShapeIndex.Builder
-
Deprecated.Removes a shape from the builder by ID.
- removeShapes(Model, Collection<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes shapes from the model while ensuring that the model is in a consistent state.
- removeShapesIf(Model, Predicate<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes shapes from the model that match the given predicate.
- removeTag(String) - Method in class software.amazon.smithy.model.traits.Protocol.Builder
-
Removes a tag from the protocol.
- removeTrait(String) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes a trait from the shape builder.
- removeTrait(ShapeId) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes a trait from the shape builder.
- RemoveTraits - Class in software.amazon.smithy.model.transform.plugins
-
Removes traits from shapes when trait definitions are removed.
- RemoveTraits() - Constructor for class software.amazon.smithy.model.transform.plugins.RemoveTraits
- removeTraitsIf(Model, BiPredicate<Shape, Trait>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Filters traits out of the model that match a predicate function.
- removeUnreferencedShapes(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes shapes (excluding service shapes) that are not referenced by any other shapes.
- removeUnreferencedShapes(Model, Predicate<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes shapes (excluding service shapes) that are not referenced by any other shapes.
- removeUnreferencedTraitDefinitions(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes definitions for traits that are not used by any shape in the model.base.
- removeUnreferencedTraitDefinitions(Model, Predicate<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes trait definitions for traits that are not used by any shape in the model.
- removeValue(String) - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Removes a value from the builder.
- renameShapes(Model, Map<ShapeId, ShapeId>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Renames shapes using ShapeId pairs while ensuring that the transformed model is in a consistent state.
- renameShapes(Model, Map<ShapeId, ShapeId>, Supplier<ModelAssembler>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Renames shapes using ShapeId pairs while ensuring that the transformed model is in a consistent state.
- replaceShapes(Model, Collection<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Adds or replaces shapes into the model while ensuring that the model is in a consistent state.
- RequiredTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a structure member is required.
- RequiredTrait() - Constructor for class software.amazon.smithy.model.traits.RequiredTrait
- RequiredTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.RequiredTrait
- RequiredTrait.Provider - Class in software.amazon.smithy.model.traits
- requiresLength(boolean) - Method in class software.amazon.smithy.model.traits.StreamingTrait.Builder
-
Indicates if the length of the stream must be known.
- reset() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Resets the state of the ModelAssembler.
- resolveShapeId(Model, String, String) - Static method in class software.amazon.smithy.model.loader.Prelude
-
Returns the resolved shape of a shape target by first checking if a shape in the namespace relative to the target matches the given name, and then by checking if a public prelude shape matches the given name.
- resolveShapeId(ShapeIndex, String, String) - Static method in class software.amazon.smithy.model.loader.Prelude
-
Deprecated.
- resource(ShapeId) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- RESOURCE - software.amazon.smithy.model.neighbor.RelationshipType
-
A resource relationship exists between a service or resource and the resources bound through the "resources" property.
- RESOURCE - software.amazon.smithy.model.shapes.ShapeType
- ResourceCycleValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that resource references do not introduce circular hierarchies.
- ResourceCycleValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ResourceCycleValidator
- ResourceIdentifierBindingValidator - Class in software.amazon.smithy.model.validation.validators
-
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 nocollection
trait are bound using an instance binding. - ResourceIdentifierBindingValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ResourceIdentifierBindingValidator
- ResourceIdentifierTrait - Class in software.amazon.smithy.model.traits
-
Binds an operation input member to a named identifier of the resource to which the operation is bound.
- ResourceIdentifierTrait(String) - Constructor for class software.amazon.smithy.model.traits.ResourceIdentifierTrait
- ResourceIdentifierTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.ResourceIdentifierTrait
- ResourceIdentifierTrait.Provider - Class in software.amazon.smithy.model.traits
- ResourceIdentifierValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that the resource identifiers of children of a resource contain all of the identifiers as their parents.
- ResourceIdentifierValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ResourceIdentifierValidator
- ResourceLifecycleValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that resource are applied appropriately to resources.
- ResourceLifecycleValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ResourceLifecycleValidator
- resources(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- resourceShape(ResourceShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- resourceShape(ResourceShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- resourceShape(ResourceShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- ResourceShape - Class in software.amazon.smithy.model.shapes
-
Represents a
resource
shape. - ResourceShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ResourceShape
. - result - Variable in exception software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Error
- result - Variable in exception software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Error
- RetryableTrait - Class in software.amazon.smithy.model.traits
-
Marks an error structure as retryable.
- RetryableTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builds a
RetryableTrait
trait. - RetryableTrait.Provider - Class in software.amazon.smithy.model.traits
- reverse(Model, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
- reverse(ShapeIndex, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Deprecated.
- run() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Executes the test runner.
- run(ExecutorService) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Executes the test runner with a specific
ExecutorService
. - runner() - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Creates a new Smithy test suite.
S
- scrubTraitDefinitions(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes all trait definitions from a model and all shapes that are only connected to the graph either directly or transitively by a trait definition shape.
- search(ToShapeId, String) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Finds all of the possible paths from the starting shape to all shapes connected to the starting shape that match the given selector.
- search(ToShapeId, Selector) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Finds all of the possible paths from the starting shape to all shapes connected to the starting shape that match the given selector.
- Segment(String, Pattern.Segment.Type) - Constructor for class software.amazon.smithy.model.pattern.Pattern.Segment
- segments(List<Pattern.Segment>) - Method in class software.amazon.smithy.model.pattern.Pattern.Builder
- select(Model) - Method in interface software.amazon.smithy.model.selector.Selector
-
Matches a selector against a model.
- select(NeighborProvider, Set<Shape>) - Method in interface software.amazon.smithy.model.selector.Selector
-
Matches a selector to a set of shapes.
- select(NeighborProvider, Model) - Method in interface software.amazon.smithy.model.selector.Selector
-
Matches a selector against a shape index using a custom neighbor visitor.
- select(NeighborProvider, ShapeIndex) - Method in interface software.amazon.smithy.model.selector.Selector
-
Deprecated.
- select(ShapeIndex) - Method in interface software.amazon.smithy.model.selector.Selector
-
Deprecated.
- selector(Selector) - Method in class software.amazon.smithy.model.traits.IdRefTrait.Builder
- selector(Selector) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- Selector - Interface in software.amazon.smithy.model.selector
-
Matches a set of shapes using a selector expression.
- SELECTOR_KEY - Static variable in class software.amazon.smithy.model.traits.TraitDefinition
- SelectorSyntaxException - Exception in software.amazon.smithy.model.selector
-
Exception thrown when a selector expression is invalid.
- SensitiveTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the data stored in the shape or member is sensitive and should be handled with care.
- SensitiveTrait() - Constructor for class software.amazon.smithy.model.traits.SensitiveTrait
- SensitiveTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.SensitiveTrait
- SensitiveTrait.Provider - Class in software.amazon.smithy.model.traits
- serialize(Model) - Method in class software.amazon.smithy.model.shapes.ModelSerializer
- service(ShapeId) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- SERVICE - software.amazon.smithy.model.shapes.ShapeType
- serviceShape(ServiceShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- serviceShape(ServiceShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- serviceShape(ServiceShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- ServiceShape - Class in software.amazon.smithy.model.shapes
-
Represents a
service
shape. - ServiceShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ServiceShape
. - ServiceValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that service shapes do not contain duplicate resource or operation shape names.
- ServiceValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ServiceValidator
- SET - software.amazon.smithy.model.shapes.ShapeType
- SET_MEMBER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
set
shapes to theirmember shapes
. - setModelAssemblerFactory(Supplier<ModelAssembler>) - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Sets a custom
ModelAssembler
factory to use to create aModelAssembler
for each test case. - setShape(SetShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- setShape(SetShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- setShape(SetShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- SetShape - Class in software.amazon.smithy.model.shapes
-
Represents a
set
shape. - SetShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
SetShape
. - severity(Severity) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the required severity of the event.
- Severity - Enum in software.amazon.smithy.model.validation
-
Severity level of a validation exception.
- shape(Shape) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the shape ID and source location based on a shape.
- Shape - Class in software.amazon.smithy.model.shapes
-
A
Shape
defines a model component. - shapeFilter(Predicate<Shape>) - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
-
Predicate that determines if a shape and its traits are serialized.
- shapeId(T) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the shape ID related to the event.
- ShapeId - Class in software.amazon.smithy.model.shapes
-
Immutable identifier for each shape in a model.
- ShapeIdConflictValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that no two shapes in the model have the same case-insensitive shape ID.
- ShapeIdConflictValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ShapeIdConflictValidator
- ShapeIdSyntaxException - Exception in software.amazon.smithy.model.shapes
-
Represents a shape ID syntax error.
- ShapeIdSyntaxException(String) - Constructor for exception software.amazon.smithy.model.shapes.ShapeIdSyntaxException
- shapeIndex(ShapeIndex) - Method in class software.amazon.smithy.model.Model.Builder
-
Deprecated.
- shapeIndex(ShapeIndex) - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
-
Deprecated.
- ShapeIndex - Class in software.amazon.smithy.model.shapes
-
Deprecated.
- ShapeIndex.Builder - Class in software.amazon.smithy.model.shapes
-
Deprecated.Builder used to construct a ShapeIndex.
- ShapeRecursionValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that list, set, and map shapes are not directly recursive, meaning that if they do have a recursive reference to themselves, one or more references that form the recursive path travels through a structure or union shape.
- ShapeRecursionValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ShapeRecursionValidator
- shapes() - Method in class software.amazon.smithy.model.Model
-
Gets a stream of
Shape
s in the index. - shapes() - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.Gets a stream of
Shape
s in the index. - shapes(Class<T>) - Method in class software.amazon.smithy.model.Model
-
Gets a stream of shapes in the index of a specific type
T
. - shapes(Class<T>) - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.Gets a stream of shapes in the index of a specific type
T
. - shapeToBuilder(S) - Static method in class software.amazon.smithy.model.shapes.Shape
-
Converts a shape, potentially of an unknown concrete type, into a Shape builder.
- ShapeType - Enum in software.amazon.smithy.model.shapes
-
An enumeration of the different types in a model.
- ShapeVisitor<R> - Interface in software.amazon.smithy.model.shapes
-
Shape visitor pattern.
- ShapeVisitor.Builder<R> - Class in software.amazon.smithy.model.shapes
-
Creates a
ShapeVisitor
used to dispatch to functions based on a model type. - ShapeVisitor.Default<R> - Class in software.amazon.smithy.model.shapes
-
Creates
ShapeVisitor
that return a value when necessary when visiting shapes. - SHORT - software.amazon.smithy.model.shapes.ShapeType
- shortShape(ShortShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- shortShape(ShortShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- shortShape(ShortShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- ShortShape - Class in software.amazon.smithy.model.shapes
-
Represents a
short
shape. - ShortShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
ShortShape
. - SimpleShape - Class in software.amazon.smithy.model.shapes
-
Abstract class representing all simple type shapes.
- since(String) - Method in class software.amazon.smithy.model.traits.DeprecatedTrait.Builder
- SinceTrait - Class in software.amazon.smithy.model.traits
-
Defines when a shape or member was added to the model.
- SinceTrait(String) - Constructor for class software.amazon.smithy.model.traits.SinceTrait
- SinceTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.SinceTrait
- SinceTrait.Provider - Class in software.amazon.smithy.model.traits
- SingleOperationBindingValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that an operation is only bound to once in an entire service closure.
- SingleOperationBindingValidator() - Constructor for class software.amazon.smithy.model.validation.validators.SingleOperationBindingValidator
- SingleResourceBindingValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that a resource is only bound to once in an entire service closure.
- SingleResourceBindingValidator() - Constructor for class software.amazon.smithy.model.validation.validators.SingleResourceBindingValidator
- size() - Method in class software.amazon.smithy.model.node.ArrayNode
-
Returns the number of elements in the array node.
- size() - Method in class software.amazon.smithy.model.node.ObjectNode
-
Returns the number of members.
- size() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
- SmithyTestCase - Class in software.amazon.smithy.model.validation.testrunner
-
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(String, List<ValidationEvent>) - Constructor for class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
- SmithyTestCase.Error - Exception in software.amazon.smithy.model.validation.testrunner
-
Thrown when errors are encountered while unwrapping a test case.
- SmithyTestCase.Result - Class in software.amazon.smithy.model.validation.testrunner
-
Output of validating a model against a test case.
- SmithyTestSuite - Class in software.amazon.smithy.model.validation.testrunner
-
Runs test cases against a directory of models and error files.
- SmithyTestSuite.Error - Exception in software.amazon.smithy.model.validation.testrunner
-
Thrown when errors are encountered in the test runner.
- SmithyTestSuite.Result - Class in software.amazon.smithy.model.validation.testrunner
-
Value result of executing the test suite.
- software.amazon.smithy.model - package software.amazon.smithy.model
- software.amazon.smithy.model.knowledge - package software.amazon.smithy.model.knowledge
- software.amazon.smithy.model.loader - package software.amazon.smithy.model.loader
- software.amazon.smithy.model.neighbor - package software.amazon.smithy.model.neighbor
- software.amazon.smithy.model.node - package software.amazon.smithy.model.node
- software.amazon.smithy.model.pattern - package software.amazon.smithy.model.pattern
- software.amazon.smithy.model.selector - package software.amazon.smithy.model.selector
- software.amazon.smithy.model.shapes - package software.amazon.smithy.model.shapes
- software.amazon.smithy.model.traits - package software.amazon.smithy.model.traits
- software.amazon.smithy.model.transform - package software.amazon.smithy.model.transform
- software.amazon.smithy.model.transform.plugins - package software.amazon.smithy.model.transform.plugins
- software.amazon.smithy.model.validation - package software.amazon.smithy.model.validation
- software.amazon.smithy.model.validation.node - package software.amazon.smithy.model.validation.node
- software.amazon.smithy.model.validation.testrunner - package software.amazon.smithy.model.validation.testrunner
- software.amazon.smithy.model.validation.validators - package software.amazon.smithy.model.validation.validators
- source(String, int, int) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the source location of the shape.
- source(SourceLocation) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the source location of the shape.
- SourceException - Exception in software.amazon.smithy.model
-
An exception that can be traced back to a
SourceLocation
. - SourceException(String, FromSourceLocation) - Constructor for exception software.amazon.smithy.model.SourceException
- SourceException(String, FromSourceLocation, Throwable) - Constructor for exception software.amazon.smithy.model.SourceException
- sourceLocation(FromSourceLocation) - Method in class software.amazon.smithy.model.traits.AbstractTraitBuilder
-
Sets the source location of where the trait was defined.
- sourceLocation(FromSourceLocation) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the source location of where the event occurred.
- sourceLocation(SourceLocation) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- sourceLocation(SourceLocation) - Method in class software.amazon.smithy.model.validation.Suppression.Builder
- SourceLocation - Class in software.amazon.smithy.model
-
Represents the source location of a model component.
- SourceLocation(String) - Constructor for class software.amazon.smithy.model.SourceLocation
- SourceLocation(String, int, int) - Constructor for class software.amazon.smithy.model.SourceLocation
- splitCamelCaseWord(String) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
-
Splits a camelCase word into a list of words.
- startingContext(String) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets an optional starting context of the validator that is prepended to each emitted validation event message.
- StreamingTrait - Class in software.amazon.smithy.model.traits
-
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 - Class in software.amazon.smithy.model.traits
-
Builds a
StreamingTrait
trait. - StreamingTrait.Provider - Class in software.amazon.smithy.model.traits
- STRING - software.amazon.smithy.model.node.NodeType
- STRING - software.amazon.smithy.model.shapes.ShapeType
- StringEnumPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the enum trait on string shapes.
- StringEnumPlugin() - Constructor for class software.amazon.smithy.model.validation.node.StringEnumPlugin
- StringLengthPlugin - Class in software.amazon.smithy.model.validation.node
-
Validates the length trait on string shapes or members that target them.
- StringLengthPlugin() - Constructor for class software.amazon.smithy.model.validation.node.StringLengthPlugin
- StringListTrait - Class in software.amazon.smithy.model.traits
-
Contains abstract functionality to build traits that contain a list of strings.
- StringListTrait(ShapeId, List<String>, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.StringListTrait
- StringListTrait.Builder<TRAIT extends StringListTrait,BUILDER extends StringListTrait.Builder> - Class in software.amazon.smithy.model.traits
-
Abstract builder to build a StringList trait.
- StringListTrait.Provider<T extends StringListTrait> - Class in software.amazon.smithy.model.traits
-
Trait provider that expects a list of string values.
- StringListTrait.StringListTraitConstructor<T extends StringListTrait> - Interface in software.amazon.smithy.model.traits
-
Factory method to create a StringList provider.
- stringNode(StringNode) - Method in class software.amazon.smithy.model.node.NodeVisitor.Default
- stringNode(StringNode) - Method in interface software.amazon.smithy.model.node.NodeVisitor
-
Visits a string node.
- StringNode - Class in software.amazon.smithy.model.node
-
Represents a string node.
- StringNode(String, SourceLocation) - Constructor for class software.amazon.smithy.model.node.StringNode
-
Creates a new StringNode.
- stringShape(StringShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- stringShape(StringShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- stringShape(StringShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- StringShape - Class in software.amazon.smithy.model.shapes
-
Represents a
string
shape. - StringShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
StringShape
. - StringTrait - Class in software.amazon.smithy.model.traits
-
Abstract trait class for traits that contain only a string value.
- StringTrait(ShapeId, String, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.StringTrait
- StringTrait.Provider<T extends StringTrait> - Class in software.amazon.smithy.model.traits
-
Trait provider that expects a string value.
- STRUCTURALLY_EXCLUSIVE_KEY - Static variable in class software.amazon.smithy.model.traits.TraitDefinition
- structurallyExclusive(boolean) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- STRUCTURE - software.amazon.smithy.model.shapes.ShapeType
- STRUCTURE_MEMBER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
structure
shapes. - structureShape(StructureShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- structureShape(StructureShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- structureShape(StructureShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- StructureShape - Class in software.amazon.smithy.model.shapes
-
Structure shape that maps shape names to members.
- StructureShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
StructureShape
. - suppress(ValidationEvent) - Method in class software.amazon.smithy.model.validation.Suppression
-
Given an event returns a mapped event that is either the same event or a suppressed version of it.
- SUPPRESSED - software.amazon.smithy.model.validation.Severity
- suppressEvent(ValidationEvent, List<Suppression>) - Static method in class software.amazon.smithy.model.validation.Suppression
-
Applies a list of suppressions to a validation event.
- Suppression - Class in software.amazon.smithy.model.validation
-
Validator suppression.
- Suppression.Builder - Class in software.amazon.smithy.model.validation
-
Builder used to create suppression definitions.
- suppressionReason(String) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets a reason for suppressing the event.
T
- tags(Collection<String>) - Method in class software.amazon.smithy.model.traits.EnumConstantBody.Builder
- TAGS - Static variable in class software.amazon.smithy.model.traits.EnumConstantBody
- TagsTrait - Class in software.amazon.smithy.model.traits
-
Applies tags to a shape.
- TagsTrait.Builder - Class in software.amazon.smithy.model.traits
- TagsTrait.Provider - Class in software.amazon.smithy.model.traits
- target(String) - Method in class software.amazon.smithy.model.shapes.MemberShape.Builder
-
Sets a member shape ID on the builder.
- target(ToShapeId) - Method in class software.amazon.smithy.model.shapes.MemberShape.Builder
-
Sets a member shape ID on the builder.
- TargetValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that neighbors target resolvable shapes of the correct type.
- TargetValidator() - Constructor for class software.amazon.smithy.model.validation.validators.TargetValidator
- testCaseCallables() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Creates a
Stream
ofCallable
objects that can be used to execute each test case. - throttling(boolean) - Method in class software.amazon.smithy.model.traits.RetryableTrait.Builder
-
Indicates if the retry is considered a throttle.
- tickedList(Collection<?>) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
-
Creates a comma separated string made up of the given collection.
- tickedList(Stream<?>) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
- TIMESTAMP - software.amazon.smithy.model.shapes.ShapeType
- TimestampFormatPlugin - Class in software.amazon.smithy.model.validation.node
-
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.
- TimestampFormatPlugin() - Constructor for class software.amazon.smithy.model.validation.node.TimestampFormatPlugin
- TimestampFormatTrait - Class in software.amazon.smithy.model.traits
-
Defines a custom serialization format for a timestamp.
- TimestampFormatTrait(String) - Constructor for class software.amazon.smithy.model.traits.TimestampFormatTrait
- TimestampFormatTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.TimestampFormatTrait
- TimestampFormatTrait.Format - Enum in software.amazon.smithy.model.traits
-
The known
timestampFormat
values. - TimestampFormatTrait.Provider - Class in software.amazon.smithy.model.traits
- timestampShape(TimestampShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- timestampShape(TimestampShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- timestampShape(TimestampShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- TimestampShape - Class in software.amazon.smithy.model.shapes
-
Represents a
timestamp
shape. - TimestampShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
TimestampShape
. - timestampValidationStrategy(TimestampValidationStrategy) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets the strategy used to validate timestamps.
- TimestampValidationStrategy - Enum in software.amazon.smithy.model.validation.node
-
Defines how timestamps are validated.
- title(String) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- TitleTrait - Class in software.amazon.smithy.model.traits
-
Provides a human-readable proper noun title to services and resources.
- TitleTrait(String) - Constructor for class software.amazon.smithy.model.traits.TitleTrait
- TitleTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.TitleTrait
- TitleTrait.Provider - Class in software.amazon.smithy.model.traits
- toBuilder() - Method in class software.amazon.smithy.model.Model
- toBuilder() - Method in class software.amazon.smithy.model.node.ObjectNode
- toBuilder() - Method in class software.amazon.smithy.model.shapes.BigDecimalShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.BigIntegerShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.BlobShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.BooleanShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ByteShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.DocumentShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.DoubleShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.FloatShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.IntegerShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ListShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.LongShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.MapShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.MemberShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.OperationShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ServiceShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.SetShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.
- toBuilder() - Method in class software.amazon.smithy.model.shapes.ShortShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.StringShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.StructureShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.TimestampShape
- toBuilder() - Method in class software.amazon.smithy.model.shapes.UnionShape
- toBuilder() - Method in class software.amazon.smithy.model.traits.AuthTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.CorsTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery
- toBuilder() - Method in class software.amazon.smithy.model.traits.EndpointTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.EnumConstantBody
- toBuilder() - Method in class software.amazon.smithy.model.traits.EnumTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- toBuilder() - Method in class software.amazon.smithy.model.traits.ExamplesTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.HttpTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.IdRefTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.LengthTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.Protocol
- toBuilder() - Method in class software.amazon.smithy.model.traits.ProtocolsTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.RangeTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- toBuilder() - Method in class software.amazon.smithy.model.traits.ReferencesTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.RetryableTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.StreamingTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.TagsTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- toBuilder() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- toBuilder() - Method in class software.amazon.smithy.model.validation.Suppression
- toBuilder() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- toNode() - Method in class software.amazon.smithy.model.node.Node
- toNode() - Method in interface software.amazon.smithy.model.node.ToNode
-
Converts a value to a
Node
. - toNode() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- toNode() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- toNode() - Method in class software.amazon.smithy.model.traits.Protocol
- toNode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- toNode() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- ToNode - Interface in software.amazon.smithy.model.node
-
A value that can be converted to a
Node
. - TopDownIndex - Class in software.amazon.smithy.model.knowledge
-
Provides top-down access to all resources and operations contained within a service or resource closure.
- TopDownIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.TopDownIndex
- toSet() - Method in class software.amazon.smithy.model.Model
-
Converts the model to an immutable Set of shapes.
- toSet() - Method in class software.amazon.smithy.model.shapes.ShapeIndex
-
Deprecated.Converts the ShapeIndex to an immutable Set of shapes.
- toShapeId() - Method in class software.amazon.smithy.model.shapes.Shape
- toShapeId() - Method in class software.amazon.smithy.model.shapes.ShapeId
- toShapeId() - Method in interface software.amazon.smithy.model.shapes.ToShapeId
- toShapeId() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- toShapeId() - Method in interface software.amazon.smithy.model.traits.Trait
-
Gets the shape ID of the trait.
- ToShapeId - Interface in software.amazon.smithy.model.shapes
-
Interface used to convert a shape to a ShapeId.
- toString() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- toString() - Method in class software.amazon.smithy.model.neighbor.Relationship
- toString() - Method in class software.amazon.smithy.model.node.BooleanNode
- toString() - Method in enum software.amazon.smithy.model.node.NodeType
- toString() - Method in class software.amazon.smithy.model.node.NullNode
- toString() - Method in class software.amazon.smithy.model.node.NumberNode
- toString() - Method in class software.amazon.smithy.model.node.StringNode
- toString() - Method in class software.amazon.smithy.model.pattern.Pattern.Segment
-
Get the segment as a literal value to be used in a pattern.
- toString() - Method in class software.amazon.smithy.model.pattern.Pattern
- toString() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
-
Converts the path to valid
Selector
syntax. - toString() - Method in class software.amazon.smithy.model.shapes.Shape
- toString() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Converts the
Id
into a shape ID string. - toString() - Method in enum software.amazon.smithy.model.shapes.ShapeType
- toString() - Method in class software.amazon.smithy.model.SourceLocation
- toString() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- toString() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- toString() - Method in enum software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- toString() - Method in class software.amazon.smithy.model.validation.Suppression
- toString() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
- toString() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Result
- toString() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- Trait - Interface in software.amazon.smithy.model.traits
-
Traits provide additional context and semantics to shapes.
- traitClass(Class<? extends Trait>) - Method in class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
-
Sets the required trait being queried.
- TraitConflictValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that traits do not conflict.
- TraitConflictValidator() - Constructor for class software.amazon.smithy.model.validation.validators.TraitConflictValidator
- TraitDefinition - Class in software.amazon.smithy.model.traits
-
Trait definition trait.
- TraitDefinition(TraitDefinition.Builder) - Constructor for class software.amazon.smithy.model.traits.TraitDefinition
- TraitDefinition.Builder - Class in software.amazon.smithy.model.traits
-
Builder to create a TraitDefinition.
- TraitDefinition.Provider - Class in software.amazon.smithy.model.traits
- traitFactory(TraitFactory) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Uses a custom
TraitFactory
to resolve and configure traits. - TraitFactory - Interface in software.amazon.smithy.model.traits
-
Creates traits using trait data from a model.
- traitFilter(Predicate<Trait>) - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
-
Sets a predicate that can be used to filter trait values from appearing in the serialized model.
- traits(Collection<Trait>) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Replace all traits in the builder.
- TraitService - Interface in software.amazon.smithy.model.traits
-
Creates traits from
Node
values. - TraitTargetValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that traits are only applied to compatible shapes.
- TraitTargetValidator() - Constructor for class software.amazon.smithy.model.validation.validators.TraitTargetValidator
- TraitValueValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that trait values are valid for their trait definitions.
- TraitValueValidator() - Constructor for class software.amazon.smithy.model.validation.validators.TraitValueValidator
U
- UNBOUND - software.amazon.smithy.model.knowledge.HttpBinding.Location
- UNION - software.amazon.smithy.model.shapes.ShapeType
- UNION_MEMBER - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
union
shapes. - unionShape(UnionShape) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Default
- unionShape(UnionShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- unionShape(UnionShape) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
- UnionShape - Class in software.amazon.smithy.model.shapes
-
Tagged union shape that maps member names to member definitions.
- UnionShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
UnionShape
. - UniqueItemsTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the members of a list must be unique.
- UniqueItemsTrait() - Constructor for class software.amazon.smithy.model.traits.UniqueItemsTrait
- UniqueItemsTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.UniqueItemsTrait
- UniqueItemsTrait.Provider - Class in software.amazon.smithy.model.traits
- UNKNOWN - software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- UnreferencedShapes - Class in software.amazon.smithy.model.neighbor
-
Finds shapes that are not connected to a service shape, are not trait definitions, and are not referenced by trait definitions.
- UnreferencedShapes() - Constructor for class software.amazon.smithy.model.neighbor.UnreferencedShapes
- UnreferencedShapes(Predicate<Shape>) - Constructor for class software.amazon.smithy.model.neighbor.UnreferencedShapes
- UnreferencedTraitDefinitions - Class in software.amazon.smithy.model.neighbor
-
Finds trait definitions that are not connected to a service shape.
- UnreferencedTraitDefinitions() - Constructor for class software.amazon.smithy.model.neighbor.UnreferencedTraitDefinitions
- UnreferencedTraitDefinitions(Predicate<Shape>) - Constructor for class software.amazon.smithy.model.neighbor.UnreferencedTraitDefinitions
- UnstableFeatureValidator - Class in software.amazon.smithy.model.validation.validators
-
Emits warnings when unstable features are used in a model, for example document shapes.
- UnstableFeatureValidator() - Constructor for class software.amazon.smithy.model.validation.validators.UnstableFeatureValidator
- unwrap() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
-
Throws an exception if the result is invalid, otherwise returns the result.
- unwrap() - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Get the result, but throw if there are any ERROR events or if the result is empty.
- update(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- UPDATE - software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the update lifecycle operation.
- uri(String) - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Builder
- uri(UriPattern) - Method in class software.amazon.smithy.model.traits.HttpTrait.Builder
- UriPattern - Class in software.amazon.smithy.model.pattern
-
Represents a URI pattern.
- UseException - Exception in software.amazon.smithy.model.loader
-
Throw when an error occurs with the IDL's
use
statements. - UseException(String, FromSourceLocation) - Constructor for exception software.amazon.smithy.model.loader.UseException
V
- validate() - Method in class software.amazon.smithy.model.validation.ValidatedResult
-
Get the optional result, and throw if there are any ERROR events.
- validate(Model) - Method in interface software.amazon.smithy.model.validation.Validator
-
Validates a model and returns a list of validation events.
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.AuthProtocolsValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.AuthValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.DeprecatedTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.EnumTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.EventPayloadTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.EventStreamValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ExamplesTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ExclusiveStructureMemberTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HostLabelTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpBindingsMissingValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpHeaderTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpLabelTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpMethodSemanticsValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpPayloadValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpPrefixHeadersTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpQueryTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpResponseCodeSemanticsValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.HttpUriConflictValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.LengthTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.PaginatedTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.PrivateAccessValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.RangeTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ReferencesTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ResourceCycleValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ResourceIdentifierBindingValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ResourceIdentifierValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ResourceLifecycleValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ServiceValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ShapeIdConflictValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ShapeRecursionValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.SingleOperationBindingValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.SingleResourceBindingValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TargetValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TraitConflictValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TraitTargetValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TraitValueValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.UnstableFeatureValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.XmlNamespaceTraitValidator
- ValidatedResult<T> - Class in software.amazon.smithy.model.validation
-
Represents the result of an operation and the
ValidationEvent
s that occurred. - ValidatedResult(T, Collection<ValidationEvent>) - Constructor for class software.amazon.smithy.model.validation.ValidatedResult
-
Creates a result with a value and events.
- ValidatedResultException - Exception in software.amazon.smithy.model.validation
-
Thrown when
ValidatedResult.validate()
is called and the result contains ERROR events. - ValidatedResultException(List<ValidationEvent>) - Constructor for exception software.amazon.smithy.model.validation.ValidatedResultException
- ValidationEvent - Class in software.amazon.smithy.model.validation
-
A validation event created when validating a model.
- ValidationEvent.Builder - Class in software.amazon.smithy.model.validation
-
Builds ValidationEvent values.
- ValidationEventFormatter - Interface in software.amazon.smithy.model.validation
-
Formats
ValidationEvent
s. - ValidationUtils - Class in software.amazon.smithy.model.validation
-
Utility methods used when validating.
- Validator - Interface in software.amazon.smithy.model.validation
-
Validates a
Model
and returns a list ofValidationEvent
. - validatorFactory(ValidatorFactory) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Sets a custom
ValidatorFactory
used to dynamically resolve validator definitions. - ValidatorFactory - Interface in software.amazon.smithy.model.validation
-
Creates built-in
Validator
instances andValidator
instances loaded by name. - ValidatorService - Interface in software.amazon.smithy.model.validation
-
Represents a service provider for configurable Validators that appear in Smithy models.
- ValidatorService.Provider - Class in software.amazon.smithy.model.validation
-
Provides a simple abstraction for creating validator service subclasses.
- value(Node) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Sets the required node value to validate.
- value(MemberShape) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- value(ShapeId) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
-
Sets the value member of the map.
- value(ShapeId, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
-
Sets the value member of the map.
- valueOf(String) - Static method in enum software.amazon.smithy.model.knowledge.HttpBinding.Location
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.neighbor.RelationshipDirection
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.neighbor.RelationshipType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.node.NodeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.pattern.Pattern.Segment.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.shapes.ShapeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.traits.TimestampFormatTrait.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum software.amazon.smithy.model.validation.Severity
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum software.amazon.smithy.model.knowledge.HttpBinding.Location
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.neighbor.RelationshipDirection
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.neighbor.RelationshipType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.node.NodeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.pattern.Pattern.Segment.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.shapes.ShapeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.traits.TimestampFormatTrait.Format
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum software.amazon.smithy.model.validation.Severity
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values(Collection<String>) - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Replaces all of the values in the builder with the given values.
- version(String) - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
- visitor() - Static method in class software.amazon.smithy.model.shapes.Shape
-
Creates a
ShapeVisitor.Builder
.
W
- Walker - Class in software.amazon.smithy.model.neighbor
-
Walks connected shapes within a shape index.
- Walker(Model) - Constructor for class software.amazon.smithy.model.neighbor.Walker
- Walker(NeighborProvider) - Constructor for class software.amazon.smithy.model.neighbor.Walker
- Walker(ShapeIndex) - Constructor for class software.amazon.smithy.model.neighbor.Walker
-
Deprecated.
- walkShapes(Shape) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the shape index, returning them in a set.
- walkShapes(Shape, Predicate<Relationship>) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the shape index, returning them in a set.
- warnIfAdditionalProperties(Collection<String>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Warns if unknown properties are found in object.
- warning(Shape, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- warning(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- WARNING - software.amazon.smithy.model.validation.Severity
- when(Class<T>, Function<T, R>) - Method in class software.amazon.smithy.model.shapes.ShapeVisitor.Builder
-
Invoked when a specific shape type is encountered.
- withDeepSortedKeys() - Method in class software.amazon.smithy.model.node.Node
-
Returns a node with sorted keys and sorted keys of all nested object nodes.
- withDeepSortedKeys(Comparator<StringNode>) - Method in class software.amazon.smithy.model.node.Node
-
Returns a node with sorted keys and sorted keys of all nested object nodes using a custom comparator.
- withMember(String) - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates a new Shape.Id with a member add to it.
- withMember(String, boolean) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withMember(String, boolean) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node with the given member added.
- withMember(String, Number) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withMember(String, Number) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node with the given member added.
- withMember(String, String) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withMember(String, String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node with the given member added.
- withMember(String, T) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withMember(String, T) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node with the given member added.
- withMember(StringNode, T) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withMember(StringNode, T) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node with the given member added.
- withOptionalMember(String, Optional<T>) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withOptionalMember(String, Optional<T>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Adds a member to a new ObjectNode if the provided value is present.
- withoutMember() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates a new Shape.Id with no member.
- withoutMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- withoutMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Constructs a new object node from the current node, but without the named member.
- withValue(Node) - Method in class software.amazon.smithy.model.node.ArrayNode
-
Copies the values from the current array node, adding the given node, returning them in a new
ArrayNode
.
X
- XmlAttributeTrait - Class in software.amazon.smithy.model.traits
-
Marks a structure member to be serialized to/from an XML attribute.
- XmlAttributeTrait() - Constructor for class software.amazon.smithy.model.traits.XmlAttributeTrait
- XmlAttributeTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.XmlAttributeTrait
- XmlAttributeTrait.Provider - Class in software.amazon.smithy.model.traits
- XmlFlattenedTrait - Class in software.amazon.smithy.model.traits
- XmlFlattenedTrait() - Constructor for class software.amazon.smithy.model.traits.XmlFlattenedTrait
- XmlFlattenedTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.XmlFlattenedTrait
- XmlFlattenedTrait.Provider - Class in software.amazon.smithy.model.traits
- XmlNamespaceTrait - Class in software.amazon.smithy.model.traits
-
Defines the XML Namespace prefix and URI.
- XmlNamespaceTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create an XmlNamespace trait.
- XmlNamespaceTrait.Provider - Class in software.amazon.smithy.model.traits
- XmlNamespaceTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that the xmlNamespace traits are applied correctly for structures.
- XmlNamespaceTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.XmlNamespaceTraitValidator
- XmlNameTrait - Class in software.amazon.smithy.model.traits
-
Provides a custom name to use when serializing a structure member name as a XML object property.
- XmlNameTrait(String) - Constructor for class software.amazon.smithy.model.traits.XmlNameTrait
- XmlNameTrait(String, SourceLocation) - Constructor for class software.amazon.smithy.model.traits.XmlNameTrait
- XmlNameTrait.Provider - Class in software.amazon.smithy.model.traits
All Classes All Packages