Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractShapeBuilder<B extends AbstractShapeBuilder<B,
S>, 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(ShapeId, Node) - 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.EnumShape
- 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.IntEnumShape
- 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
-
Deprecated.
- 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
- ADD - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Emit when a trait or value is added that previously did not exist.
- addBreakingChange(TraitDefinition.BreakingChangeRule) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- addClientOptional(Model, boolean) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Add the clientOptional trait to members that are effectively nullable because they are part of a structure marked with the input trait or they aren't required and don't have a default trait.
- 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(EnumDefinition) - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
-
Deprecated.
- addError(String) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Adds an error to the operation.
- addError(String) - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
-
Adds an error to the service that is implicitly bound to every operation within the closure of the service.
- addError(ToShapeId) - 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.ServiceShape.Builder
-
Adds an error to the service that is implicitly bound to every operation within the closure of the service.
- addErrors(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Adds an each of the errors to the operation.
- addErrors(List<ShapeId>) - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
-
Adds errors to the service that are implicitly bound to every operation within the closure of the service.
- 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
- addLocalTrait(ShapeId) - Method in class software.amazon.smithy.model.traits.MixinTrait.Builder
- addMember(String, int) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
-
Adds a member to the builder.
- addMember(String, int, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
-
Adds a member to the builder.
- addMember(String, String) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Adds a member to the builder.
- addMember(String, String, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Adds a member to the builder.
- addMember(String, ShapeId) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
-
Adds a member to the builder.
- addMember(String, ShapeId, Consumer<MemberShape.Builder>) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
-
Adds a member to the 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.EnumShape.Builder
-
Adds a member to the shape.
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- addMember(MemberShape) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- addMixin(Shape) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds a mixin to the shape.
- addMixin(Shape) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- addMixin(Shape) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- addMixin(Shape) - Method in class software.amazon.smithy.model.shapes.UnionShape.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
- addProperty(String, String) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- addProperty(String, ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- 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(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.
- addShapes(Collection<S>) - Method in class software.amazon.smithy.model.Model.Builder
-
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.
- addTag(String) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- 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(ShapeId) - Method in class software.amazon.smithy.model.traits.AuthDefinitionTrait.Builder
- addTrait(ShapeId) - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.Builder
- addTrait(ShapeId, Trait) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Explicitly adds a trait to a shape in the assembled model.
- addTrait(Trait) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds a trait to the shape builder, replacing any conflicting traits.
- addTrait(Trait) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- addTraits(Collection<? extends Trait>) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Adds traits from an iterator to the shape builder, replacing any conflicting traits.
- addTraits(Collection<? extends Trait>) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- addUnparsedModel(String, String) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Adds a string containing an unparsed model to the assembler.
- addUrl(String, String) - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait.Builder
- addValidator(Validator) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Registers a validator to be used when validating the model.
- addValue(String) - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Adds a value to the builder.
- addValue(Node, Node) - Method in class software.amazon.smithy.model.node.NodePointer
-
Adds or replaces a
value
incontainer
at the JSON pointer location. - addWithIntermediateValues(Node, Node) - Method in class software.amazon.smithy.model.node.NodePointer
-
Adds or replaces a
value
incontainer
at the JSON pointer location. - AGGREGATE - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType.Category
- 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
-
Deprecated.
- allowOptionalNull(boolean) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
-
Configure how null values are handled when they are provided for optional types.
- allowsGreedyLabels(boolean) - Method in class software.amazon.smithy.model.pattern.SmithyPattern.Builder
- AnnotationTrait - Class in software.amazon.smithy.model.traits
-
Trait implementation for traits that are an empty object.
- AnnotationTrait(ShapeId, ObjectNode) - Constructor for class software.amazon.smithy.model.traits.AnnotationTrait
- AnnotationTrait.Provider<T extends AnnotationTrait> - Class in software.amazon.smithy.model.traits
-
Trait provider that expects a boolean value of true.
- ANY - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Emit when any change occurs.
- APPLIED_TRAIT - Enum constant in enum class software.amazon.smithy.model.knowledge.TextInstance.TextLocationType
- apply(Shape, Node, NodeValidatorPlugin.Context, BiConsumer<FromSourceLocation, String>) - Method in interface software.amazon.smithy.model.validation.node.NodeValidatorPlugin
-
Applies the plugin to the given shape, node value, and model.
- ARRAY - Enum constant in enum class 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
- ArrayNode.Builder - Class in software.amazon.smithy.model.node
-
Builder used to efficiently create an 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
- asEnumShape() - Method in class software.amazon.smithy.model.shapes.EnumShape
- asEnumShape() - 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
- asIntEnumShape() - Method in class software.amazon.smithy.model.shapes.IntEnumShape
- asIntEnumShape() - 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
-
Deprecated.
- asSetShape() - Method in class software.amazon.smithy.model.shapes.Shape
-
Deprecated.
- 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
- AttributeValue - Interface in software.amazon.smithy.model.selector
-
Selector attribute values are the data model of selectors.
- AuthDefinitionTrait - Class in software.amazon.smithy.model.traits
-
This trait is attached to another trait to define an auth scheme.
- AuthDefinitionTrait(AuthDefinitionTrait.Builder) - Constructor for class software.amazon.smithy.model.traits.AuthDefinitionTrait
- AuthDefinitionTrait.Builder - Class in software.amazon.smithy.model.traits
- AuthDefinitionTrait.Provider - Class in software.amazon.smithy.model.traits
- AuthTrait - Class in software.amazon.smithy.model.traits
-
Specifies the auth schemes supported by default for operations bound to a service.
- AuthTrait(List<ShapeId>) - Constructor for class software.amazon.smithy.model.traits.AuthTrait
-
Deprecated.
- AuthTrait(List<ShapeId>, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.AuthTrait
-
Deprecated.
- AuthTrait(Set<ShapeId>) - Constructor for class software.amazon.smithy.model.traits.AuthTrait
- AuthTrait(Set<ShapeId>, FromSourceLocation) - Constructor for class software.amazon.smithy.model.traits.AuthTrait
- AuthTrait.Provider - Class in software.amazon.smithy.model.traits
- AuthTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
All
@auth
trait values referenced from an operation must refer to authentication traits applied to service shapes that enclose the operation. - AuthTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.AuthTraitValidator
B
- basePath(Path) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.Builder
-
A base path to use for any created models.
- BIG_DECIMAL - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- BIG_INTEGER - Enum constant in enum class 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 - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- 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 - Enum constant in enum class software.amazon.smithy.model.node.NodeType
- BOOLEAN - Enum constant in enum class 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
. - 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 - Enum constant in enum class 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
-
Deprecated.
- BoxIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.BoxIndex
-
Deprecated.
- BoxTrait - Class in software.amazon.smithy.model.traits
-
Deprecated.
- BoxTrait() - Constructor for class software.amazon.smithy.model.traits.BoxTrait
-
Deprecated.
- BoxTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.BoxTrait
-
Deprecated.
- BoxTrait.Provider - Class in software.amazon.smithy.model.traits
-
Deprecated.
- BreakingChangeRule(NodePointer, Severity, TraitDefinition.ChangeType, String) - Constructor for class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- breakingChanges(List<TraitDefinition.BreakingChangeRule>) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- build() - Method in class software.amazon.smithy.model.Model.Builder
- build() - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
- build() - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- build() - Method in class software.amazon.smithy.model.pattern.SmithyPattern.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.EnumShape.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.IntEnumShape.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
-
Deprecated.
- build() - Method in class software.amazon.smithy.model.shapes.ShortShape.Builder
- build() - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.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.AuthDefinitionTrait.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.EnumDefinition.Builder
- build() - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
-
Deprecated.
- build() - Method in class software.amazon.smithy.model.traits.EnumValueTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- build() - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.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.MixinTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.PropertyTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.RangeTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.RecommendedTrait.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.SuppressTrait.Builder
- build() - Method in class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait.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.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.node.ArrayNode
- builder() - Static method in class software.amazon.smithy.model.node.ObjectNode
- builder() - Static method in class software.amazon.smithy.model.pattern.SmithyPattern
- 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.EnumShape
- 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.IntEnumShape
- 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
-
Deprecated.
- builder() - Static method in class software.amazon.smithy.model.shapes.ShortShape
- builder() - Static method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer
- 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.AuthDefinitionTrait
- 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.EnumDefinition
- builder() - Static method in class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.
- builder() - Static method in class software.amazon.smithy.model.traits.EnumValueTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ExamplesTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- builder() - Static method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- builder() - Static method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- builder() - Static method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- 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.MixinTrait
- builder() - Static method in class software.amazon.smithy.model.traits.PaginatedTrait
- builder() - Static method in class software.amazon.smithy.model.traits.PropertyTrait
- builder() - Static method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
- builder() - Static method in class software.amazon.smithy.model.traits.RangeTrait
- builder() - Static method in class software.amazon.smithy.model.traits.RecommendedTrait
- 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.SuppressTrait
- builder() - Static method in class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait
- 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.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.EnumShape.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.IntEnumShape.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
-
Deprecated.
- Builder() - Constructor for class software.amazon.smithy.model.shapes.ShortShape.Builder
- Builder() - Constructor for class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.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.AuthDefinitionTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EnumDefinition.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.EnumTrait.Builder
-
Deprecated.
- Builder() - Constructor for class software.amazon.smithy.model.traits.EnumValueTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ExternalDocumentationTrait.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.MixinTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.PropertyTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.RangeTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.RecommendedTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.StringListTrait.Builder
- Builder() - Constructor for class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait.Builder
- BYTE - Enum constant in enum class 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
- cached(NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Caches the results of calling a delegate provider.
- canConvertToEnum(StringShape, boolean) - Static method in class software.amazon.smithy.model.shapes.EnumShape
-
Determines whether a given string shape can be converted to an enum shape.
- canSuppress() - Method in enum class software.amazon.smithy.model.validation.Severity
-
Check if the severity level of the error can be suppressed.
- changeShapeType(Model, Map<ShapeId, ShapeType>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Changes the type of each given shape.
- changeShapeType(Model, Map<ShapeId, ShapeType>, ChangeShapeTypeOption...) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Changes the type of each given shape.
- ChangeShapeTypeOption - Enum Class in software.amazon.smithy.model.transform
-
Options that can be enabled when changing shape types.
- changeStringEnumsToEnumShapes(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Changes each compatible string shape with the enum trait to an enum shape.
- changeStringEnumsToEnumShapes(Model, boolean) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Changes each compatible string shape with the enum trait to an enum shape.
- 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
- CleanServiceRenames - Class in software.amazon.smithy.model.transform.plugins
-
Removes "rename" entries from service shapes when a shape is removed.
- CleanServiceRenames() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanServiceRenames
- 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
- CleanTraitDefinitions - Class in software.amazon.smithy.model.transform.plugins
-
Removes traits from
AuthDefinitionTrait
andProtocolDefinitionTrait
traits that refer to removed shapes. - CleanTraitDefinitions() - Constructor for class software.amazon.smithy.model.transform.plugins.CleanTraitDefinitions
- clearBreakingChanges() - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- clearCollectionOperations() - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- clearEnums() - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
-
Deprecated.
- clearErrors() - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Removes all errors.
- clearErrors() - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
-
Removes all errors.
- clearExamples() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes all members from the builder.
- clearMembers() - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- clearMembers() - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- clearMetadata() - Method in class software.amazon.smithy.model.Model.Builder
- clearMixins() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes all mixins.
- clearOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- clearReferences() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Builder
- clearRename() - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
- clearResources() - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- clearTags() - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- clearTraits() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes all traits.
- clearTraits() - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- clearUrls() - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait.Builder
- clearValues() - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Clears all values out of the builder.
- CLIENT - Enum constant in enum class software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
-
A client, or any other kind of non-authoritative model consumer that must honor the
InputTrait
andClientOptionalTrait
. - CLIENT_CAREFUL - Enum constant in enum class software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
-
Like
NullableIndex.CheckMode.CLIENT
mode, but will treat all members that target structures and unions as optional because these members can never transition to optional using a default trait. - ClientOptionalTrait - Class in software.amazon.smithy.model.traits
-
Indicates that non-authoritative code generators should treat a member as optional even if it's required or default.
- ClientOptionalTrait() - Constructor for class software.amazon.smithy.model.traits.ClientOptionalTrait
- ClientOptionalTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.ClientOptionalTrait
- ClientOptionalTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.ClientOptionalTrait
- ClientOptionalTrait.Provider - Class in software.amazon.smithy.model.traits
- code(int) - Method in class software.amazon.smithy.model.traits.HttpTrait.Builder
- 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 - Enum constant in enum class software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Indicates that the operation is bound to a resource as a collection operation.
- COLLECTION_OPERATION - Enum constant in enum class 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.
- 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<B,
S>, 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.
- compare(FromSourceLocation, FromSourceLocation) - Static method in interface software.amazon.smithy.model.FromSourceLocation
-
Compares two FromSourceLocations.
- compareTo(StringNode) - Method in class software.amazon.smithy.model.node.StringNode
- compareTo(Shape) - Method in class software.amazon.smithy.model.shapes.Shape
- compareTo(ShapeId) - Method in class software.amazon.smithy.model.shapes.ShapeId
- compareTo(SourceLocation) - Method in class software.amazon.smithy.model.SourceLocation
- 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
- Config() - Constructor for class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
- Config() - Constructor for class software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator.Config
- conflictsWith(UriPattern) - Method in class software.amazon.smithy.model.pattern.UriPattern
-
Determines if the pattern conflicts with another pattern.
- consumeIdentifier(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Expects and skips over a Smithy identifier production.
- consumeMatches(Model, Consumer<Selector.ShapeMatch>) - Method in interface software.amazon.smithy.model.selector.Selector
-
Matches a selector to a set of shapes and receives each matched shape with the variables that were set when the shape was matched.
- consumeNamespace(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Expects and consumes a valid Smithy shape ID namespace.
- containsMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Checks if the given member name exists in the ObjectNode.
- content(ObjectNode) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample.Builder
- Context(Model) - Constructor for class software.amazon.smithy.model.validation.node.NodeValidatorPlugin.Context
- 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.
- copyServiceErrorsToOperations(Model, ServiceShape) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Copies the errors defined on the given service onto each operation bound to the service, effectively flattening service error inheritance.
- 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(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(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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the create lifecycle operation.
- createBuilderForType() - Method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Creates a shape builder that corresponds to the shape type.
- createDedicatedInputAndOutput(Model, String, String) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Updates the model so that every operation has a dedicated input shape marked with the
input
trait and output shape marked with theoutput
trait, and the targeted shapes all have a consistent shape name of OperationName +inputSuffix
/outputSuffix
depending on the context. - createEvent(Severity, Shape, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- createEvent(Severity, Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.model.validation.AbstractValidator
- 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.AuthDefinitionTrait
- createNode() - Method in class software.amazon.smithy.model.traits.AuthTrait
- createNode() - Method in class software.amazon.smithy.model.traits.CorsTrait
- createNode() - Method in class software.amazon.smithy.model.traits.DefaultTrait
- 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
-
Deprecated.
- createNode() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ExamplesTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- createNode() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- 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.MixinTrait
- createNode() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- createNode() - Method in class software.amazon.smithy.model.traits.PropertyTrait
- createNode() - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
- createNode() - Method in class software.amazon.smithy.model.traits.RangeTrait
- createNode() - Method in class software.amazon.smithy.model.traits.RecommendedTrait
- 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.StringListTrait
- createNode() - Method in class software.amazon.smithy.model.traits.StringTrait
- createNode() - Method in class software.amazon.smithy.model.traits.synthetic.OriginalShapeIdTrait
- createNode() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- createNode() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- 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 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.AnnotationTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.AuthDefinitionTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.AuthTrait.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.DefaultTrait.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
-
Deprecated.
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.EnumValueTrait.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.ExternalDocumentationTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.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.MixinTrait.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.PropertyTrait.Provider
- createTrait(ShapeId, Node) - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.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.RecommendedTrait.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.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
. - CycleException(Set<ShapeId>, List<ShapeId>) - Constructor for exception software.amazon.smithy.model.loader.TopologicalShapeSort.CycleException
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 - Enum constant in enum class software.amazon.smithy.model.validation.Severity
- DATE_TIME - Enum constant in enum class 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
- defaultParameterizedTestSource(Class<?>) - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Factory method used to easily create a JUnit 5
ParameterizedTest
MethodSource
based on the givenClass
. - DefaultTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a shape is defaulted, meaning a zero value is used when one is not provided.
- DefaultTrait(Node) - Constructor for class software.amazon.smithy.model.traits.DefaultTrait
- DefaultTrait.Provider - Class in software.amazon.smithy.model.traits
- DefaultTraitValidator - Class in software.amazon.smithy.model.validation.validators
- DefaultTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.DefaultTraitValidator
- DefaultValueInUpdateValidator - Class in software.amazon.smithy.model.validation.validators
-
Finds operations that are meant to partially update a resource, but that use members with default values in their input shapes, making it impossible to know if the member was provided explicitly or defaulted.
- DefaultValueInUpdateValidator() - Constructor for class software.amazon.smithy.model.validation.validators.DefaultValueInUpdateValidator
- delete(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- DELETE - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the delete lifecycle operation.
- deprecated(boolean) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- 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
- dequeueSortedShapes() - Method in class software.amazon.smithy.model.loader.TopologicalShapeSort
-
Sort the shapes and returns the ordered list of shape IDs.
- deserialize(Node, Class<T>) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Deserialize a Node
value
into an instance ofT
. - deserializeCollection(Node, Class<T>, Class<U>) - Method in class software.amazon.smithy.model.node.NodeMapper
- deserializeInto(Node, T) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Invokes setters on the given
objectToMutate
from the providedNode
. - deserializeMap(Node, Class<T>, Class<U>) - Method in class software.amazon.smithy.model.node.NodeMapper
- determineRequestContentType(ToShapeId, String) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns the expected request Content-Type of the given operation.
- determineRequestContentType(ToShapeId, String, 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.
- determineResponseContentType(ToShapeId, String, 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 - Enum constant in enum class 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. - disableFromNodeForClass(Type) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Disables the use of
fromNode
method for a specific class when deserializing the class. - disablePrelude() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Disables automatically loading the prelude models.
- disableToNodeForClass(Type) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Disables the use of the
toNode
method for a specific class when serializing the class as a POJO. - disableValidation() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Disables additional validation of the model.
- 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 - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- DOCUMENT - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- documentation(String) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- documentation(String) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- 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
. - doesMemberShapeRequireProperty(MemberShape) - Method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
-
Returns true if member is required to have an associated property mapping.
- DOUBLE - Enum constant in enum class 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
. - downgradeEnums(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Changes each enum shape to a string shape and each intEnum to an integer.
- 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 model for effective traits bound to shapes and members.
- EffectiveTraitQuery.Builder - Class in software.amazon.smithy.model.traits
-
Builds a reusable EffectiveTraitQuery.
- EmitEachSelectorValidator - Class in software.amazon.smithy.model.validation.linters
-
Emits a validation event for each shape that matches a selector.
- EmitEachSelectorValidator(EmitEachSelectorValidator.Config) - Constructor for class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator
- EmitEachSelectorValidator.Config - Class in software.amazon.smithy.model.validation.linters
-
EmitEachSelector configuration settings.
- EmitEachSelectorValidator.Provider - Class in software.amazon.smithy.model.validation.linters
- EmitNoneSelectorValidator - Class in software.amazon.smithy.model.validation.linters
-
Emits a validation event if no shapes match the given selector.
- EmitNoneSelectorValidator.Config - Class in software.amazon.smithy.model.validation.linters
-
EmitNoneSelector configuration settings.
- EmitNoneSelectorValidator.Provider - Class in software.amazon.smithy.model.validation.linters
- empty() - Static method in class software.amazon.smithy.model.node.NodePointer
-
Gets an empty Node pointer.
- empty() - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Creates an empty ValidatedResult with no value and no events.
- emptyValue() - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates an empty
AttributeValue
object. - enableFromNodeForClass(Type) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Enables the use of the
FromNode
method for a specific class when deserializing the class. - enableToNodeForClass(Type) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Enables the use of the
toNode
method for a specific class when serializing the class as a POJO. - 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
- enqueue(Shape) - Method in class software.amazon.smithy.model.loader.TopologicalShapeSort
-
Add a shape to the sort queue, and automatically extract dependencies.
- enqueue(ShapeId, Collection<ShapeId>) - Method in class software.amazon.smithy.model.loader.TopologicalShapeSort
-
Add a shape to the sort queue, and provide an explicit dependencies list.
- EntityShape - Class in software.amazon.smithy.model.shapes
-
Abstract class representing service and resource shapes.
- EntityShape.Builder<B extends EntityShape.Builder<B,
S>, S extends EntityShape> - Class in software.amazon.smithy.model.shapes -
Builder used to create a Service or Resource shape.
- ENUM - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- ENUM_MEMBER - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
enum
shapes to theirmember shapes
. - EnumDefinition - Class in software.amazon.smithy.model.traits
-
An enum definition for the enum trait.
- EnumDefinition.Builder - Class in software.amazon.smithy.model.traits
-
Builds a
EnumDefinition
. - enumShape(EnumShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- EnumShape - Class in software.amazon.smithy.model.shapes
- EnumShape.Builder - Class in software.amazon.smithy.model.shapes
- EnumShapeValidator - Class in software.amazon.smithy.model.validation.validators
-
Emits an error validation event if an enum member's enumValue trait has the wrong type, if there are any duplicate values in a single enum, if the enum's default value is set using the enumValue trait, or if an intEnum member lacks an enumValue trait.
- EnumShapeValidator() - Constructor for class software.amazon.smithy.model.validation.validators.EnumShapeValidator
- EnumTrait - Class in software.amazon.smithy.model.traits
-
Deprecated.
- EnumTrait(ShapeId, EnumTrait.Builder) - Constructor for class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.
- EnumTrait.Builder - Class in software.amazon.smithy.model.traits
-
Deprecated.Builder used to create the enum trait.
- EnumTrait.Provider - Class in software.amazon.smithy.model.traits
-
Deprecated.
- 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
- EnumValueTrait - Class in software.amazon.smithy.model.traits
-
Sets the value for an enum member.
- EnumValueTrait.Builder - Class in software.amazon.smithy.model.traits
- EnumValueTrait.Provider - Class in software.amazon.smithy.model.traits
- EPOCH_SECONDS - Enum constant in enum class software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- EPOCH_SECONDS - Enum constant in enum class 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.NodePointer
- 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.SmithyPattern
- equals(Object) - Method in class software.amazon.smithy.model.pattern.SmithyPattern.Segment
- equals(Object) - Method in class software.amazon.smithy.model.pattern.UriPattern
- equals(Object) - Method in class software.amazon.smithy.model.shapes.EntityShape
- 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.SourceLocation
- equals(Object) - Method in class software.amazon.smithy.model.traits.AbstractTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.AnnotationTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.CorsTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.EnumDefinition
- equals(Object) - Method in class software.amazon.smithy.model.traits.HttpTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.ReferencesTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- equals(Object) - Method in class software.amazon.smithy.model.traits.RetryableTrait
- equals(Object) - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- equals(Object) - Method in class software.amazon.smithy.model.traits.TraitDefinition
- 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(ExamplesTrait.ErrorExample) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
- ERROR - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - ERROR - Enum constant in enum class software.amazon.smithy.model.validation.Severity
- ErrorExample(ExamplesTrait.ErrorExample.Builder) - Constructor for class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- 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.
- errors(Collection<ShapeId>) - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
-
Sets and replaces the errors of the service.
- 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(ObjectNode) - 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
-
Deprecated.
- 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(ObjectNode) - 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.
- 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.ErrorExample - Class in software.amazon.smithy.model.traits
- ExamplesTrait.ErrorExample.Builder - Class in software.amazon.smithy.model.traits
- 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.
- expectArrayMember(String, Function<N, T>, Consumer<List<T>>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Requires that the given member exists and is an array; then creates a list of values for the array by passing array element through the mapping function, and passes that list to the consumer.
- 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. - expectArrayNode(Supplier<String>) - Method in class software.amazon.smithy.model.node.ArrayNode
- expectArrayNode(Supplier<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.
- expectBooleanMember(String, Consumer<Boolean>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Requires that
key
exists, is a boolean, and passes the value toconsumer
. - 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. - expectBooleanNode(Supplier<String>) - Method in class software.amazon.smithy.model.node.BooleanNode
- expectBooleanNode(Supplier<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. - expectInputShape(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the input shape of an operation, and returns Smithy's Unit type trait if the operation has no meaningful input.
- expectIntValue() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
-
Gets the int value.
- 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. - expectMember(String, Function<Node, T>, Consumer<T>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Requires that the
key
member is present, passes the value through the givenmapper
, and then passes the mapped value toconsumer
. - expectMember(String, Supplier<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
- expectNullNode(Supplier<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(Supplier<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.
- expectNumberMember(String, Consumer<Number>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Requires that
key
exists, is a number, and passes the value toconsumer
. - 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
- expectNumberNode(Supplier<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(Supplier<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.
- expectObjectMember(String, Consumer<ObjectNode>) - 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
- expectObjectNode(Supplier<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(Supplier<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.
- expectOutputShape(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the output shape of an operation, and returns Smithy's unit type trait if the operation has no meaningful output.
- 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.
- expectStringMember(String, Consumer<String>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Requires that
key
exists, is a string, and passes the value toconsumer
. - 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
- expectStringNode(Supplier<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(Supplier<String>) - Method in class software.amazon.smithy.model.node.StringNode
- expectStringValue() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
-
Gets the string value.
- 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 named links to external documentation.
- ExternalDocumentationTrait(ExternalDocumentationTrait.Builder) - Constructor for class software.amazon.smithy.model.traits.ExternalDocumentationTrait
- ExternalDocumentationTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create the external documentation trait.
- ExternalDocumentationTrait.Provider - Class in software.amazon.smithy.model.traits
F
- FAIL - Enum constant in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Throws an exception when attempting to deserialize an unknown property.
- 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
-
Deprecated.
- 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.
- 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.EnumShape
- 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
-
Deprecated.
- flattenAndRemoveMixins(Model) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Flattens mixins out of the model and removes them from the model.
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes mixins from a shape and flattens them into the shape.
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.EntityShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
- flattenMixins() - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
- FLOAT - Enum constant in enum class 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 - Enum constant in enum class 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.
- from(ToNode) - Static method in class software.amazon.smithy.model.node.Node
-
Create a Node from a potentially null
ToNode
value. - fromErrors(Collection<ValidationEvent>) - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Deprecated.
- fromErrors(List<ValidationEvent>) - Static method in class software.amazon.smithy.model.validation.ValidatedResult
-
Creates a new ValidatedResult with no values and a list of
ValidationEvent
s. - fromMetadata(Node) - Static method in interface software.amazon.smithy.model.validation.suppressions.Suppression
-
Creates a suppression from a
Node
found in the "suppressions" metadata of a Smithy model. - fromModelFile(String) - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase
-
Creates a test case from a model file.
- fromNode(Node) - Static method in class software.amazon.smithy.model.node.NodePointer
-
Creates a NodePointer from a Node value.
- fromNode(Node) - Static method in interface software.amazon.smithy.model.selector.Selector
-
Creates a Selector from a
Node
. - fromNode(Node) - Static method in class software.amazon.smithy.model.shapes.ShapeId
- fromNode(Node) - Static method in class software.amazon.smithy.model.traits.EnumDefinition
- fromNode(Node) - Static method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- fromNode(Node) - Static method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
-
Creates a TraitDiffRule from a Node.
- fromNode(Node) - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Creates a ChangeType value from a node.
- fromNode(Node) - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
- fromNode(Node) - Static method in enum class software.amazon.smithy.model.validation.Severity
-
Creates a severity value from a node.
- fromNode(Node) - Static method in class software.amazon.smithy.model.validation.ValidationEvent
- fromNodes(List<? extends 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
. - fromSourceException(SourceException, String, ShapeId) - 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 class software.amazon.smithy.model.shapes.ShapeType
-
Create a new Shape.Type from a string.
- fromString(String) - Static method in enum class 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 class 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
- fromStringRepresentation(String) - Static method in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
-
Convert a string value into a NonNumericFloat.
- 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. - fromStringShape(StringShape) - Static method in class software.amazon.smithy.model.shapes.EnumShape
-
Converts a base
StringShape
to anEnumShape
if possible. - fromStringShape(StringShape, boolean) - Static method in class software.amazon.smithy.model.shapes.EnumShape
-
Converts a base
StringShape
to anEnumShape
if possible. - fromSuppressTrait(Shape) - Static method in interface software.amazon.smithy.model.validation.suppressions.Suppression
-
Creates a suppression using the
SuppressTrait
of the given shape. - 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
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.CollectionShape
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.EnumShape
-
Gets the members of the shape, including mixin members.
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.IntEnumShape
-
Gets the members of the shape, including mixin members.
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.MapShape
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets the members of the shape, including mixin members.
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.StructureShape
- getAllMembers() - Method in class software.amazon.smithy.model.shapes.UnionShape
- 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.AbstractShapeBuilder
-
Get an immutable view of the traits applied to the builder.
- getAllTraits() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets all of the traits attached to the shape.
- getAppliedTraits() - Method in class software.amazon.smithy.model.Model
-
Gets a set of every trait shape ID that is used in the model.
- 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.
- getArrayMember(String, Consumer<List<Node>>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
Gets the nodes of an optional member that contains an array.
- getArrayMember(String, Function<N, T>, Consumer<List<T>>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
The same as
ObjectNode.expectArrayMember(String, Function, Consumer)
, but the member is optional. - getAuthSchemes(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.ServiceIndex
-
Get all auth defining traits attached to a service or operation.
- getBigDecimalShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bigDecimals in the Model.
- getBigDecimalShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bigDecimals in the Model that have a specific trait.
- getBigIntegerShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bigIntegers in the Model.
- getBigIntegerShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bigIntegers in the Model that have a specific trait.
- getBindingTrait() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getBindToTrait() - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
-
Gets the optional trait that each emitted event is bound to.
- getBlobShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all blobs in the Model.
- getBlobShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all blobs in the Model that have a specific trait.
- 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.
- getBooleanMember(String, Consumer<Boolean>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
The same as
ObjectNode.expectBooleanMember(String, Consumer)
but the member is optional. - 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.
- getBooleanShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all booleans in the Model.
- getBooleanShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all booleans in the Model that have a specific trait.
- getBreakingChanges() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- getBuiltins() - Static method in interface software.amazon.smithy.model.validation.node.NodeValidatorPlugin
- getByteShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bytes in the Model.
- getByteShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all bytes in the Model that have a specific trait.
- getCategory() - Method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Returns the category of the shape type, as defined in the Smithy specification (one of SIMPLE, AGGREGATE, or SERVICE).
- getChange() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- 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
-
Deprecated.
- getConflictingLabelSegmentsMap(SmithyPattern) - Method in class software.amazon.smithy.model.pattern.SmithyPattern
-
Gets a map of explicitly conflicting 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.SmithyPattern.Segment
-
Get the content of the segment.
- getContent() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- getContextualName(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Gets the contextual name of a shape within the closure.
- getCreate() - Method in class software.amazon.smithy.model.shapes.ResourceShape
-
Gets the create lifecycle operation of the resource.
- getCurrentShapes() - Method in class software.amazon.smithy.model.Model.Builder
-
Gets an immutable view of the current shapes in the builder.
- 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.
- getDefaultedPath() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- getDefaultedSeverity() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- getDefaultHttpStatusCode() - Method in class software.amazon.smithy.model.traits.ErrorTrait
-
Returns the recommended default HTTP status code of the error.
- 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 class software.amazon.smithy.model.neighbor.RelationshipType
-
Gets the direction of the relationship.
- getDisableFromNode() - Method in class software.amazon.smithy.model.node.NodeMapper
-
Gets the set of classes where
fromNode
is disabled. - getDisableToNode() - Method in class software.amazon.smithy.model.node.NodeMapper
-
Gets the set of classes where
toNode
is disabled. - getDocumentation() - Method in class software.amazon.smithy.model.traits.EnumDefinition
- getDocumentation() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getDocumentShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all documents in the Model.
- getDocumentShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all documents in the Model that have a specific trait.
- getDoubleShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all doubles in the Model.
- getDoubleShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all doubles in the Model that have a specific trait.
- getEffectiveAuthSchemes(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.ServiceIndex
-
Gets a list of effective authentication schemes applied to a service.
- getEffectiveAuthSchemes(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.ServiceIndex
-
Gets a list of effective authentication schemes applied to an operation bound within a service.
- 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.
- getEnumDefinitionValues() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.Gets the acceptable enum literal values.
- getEnumShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all enums in the Model.
- getEnumShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all enums in the Model that have a specific trait.
- getEnumValues() - Method in class software.amazon.smithy.model.shapes.EnumShape
-
Gets a map of enum member names to their corresponding values.
- getEnumValues() - Method in class software.amazon.smithy.model.shapes.IntEnumShape
-
Gets a map of enum member names to their corresponding values.
- getError() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- 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 bound directly to the operation that can be encountered.
- getErrors() - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Gets a list of the common errors that can be encountered by every operation in the service.
- getErrors(ServiceShape) - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets a list of the error shape IDs the operation can encounter, including any common errors of a service.
- getErrors(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the list of error structures defined on an operation.
- getErrors(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the list of error structures defined on an operation, including any common errors inherited from a service shape.
- getEventId() - Method in class software.amazon.smithy.model.validation.ValidationEvent
-
Deprecated.Use the
getId()
method to match the node format. - 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.
- 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
- getFlattenedValues() - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Gets all of the attribute values contained in the attribute value.
- getFloatShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all floats in the Model.
- getFloatShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all floats in the Model that have a specific trait.
- 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.SmithyPattern
-
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. - getId() - Method in class software.amazon.smithy.model.validation.ValidationEvent
-
Returns the identifier of the validation event.
- 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
- getIn() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- 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
-
Gets the optional input structure of an operation, and returns an empty optional if the input targets
smithy.api#Unit
. - getInputInfo(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.EventStreamIndex
-
Get event stream information for the input of an operation.
- getInputMembers(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the input members of an operation as a map of member names to
MemberShape
. - getInputPropertiesShape(OperationShape) - Method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
-
Resolves and returns the input shape of an operation that contains the top-level resource bound properties.
- getInputShape() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets the input of the operation.
- getInputShape(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the optional input structure of an operation.
- getInputToken() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getInputTokenMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
- getIntegerShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all integers in the Model.
- getIntegerShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all integers in the Model that have a specific trait.
- getIntEnumShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all intEnums in the Model.
- getIntEnumShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all intEnums in the Model that have a specific trait.
- getIntroducedErrors() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets the errors introduced by the shape and not inherited from mixins.
- getIntroducedErrors() - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Gets the list of common errors introduced by the shape and not inherited from mixins.
- getIntroducedOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape
-
Gets operations bound through the "operations" property that were not inherited from mixins.
- getIntroducedRename() - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Gets the rename map introduced by the shape and not inherited from mixins.
- getIntroducedResources() - Method in class software.amazon.smithy.model.shapes.EntityShape
-
Gets all the directly-bound resources introduced by this shape and not inherited from mixins.
- getIntroducedTraits() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets the traits introduced by the shape and not inherited from mixins.
- getIntroducedVersion() - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Gets the version of the service introduced by the shape and not inherited from mixins.
- getIntValue() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
-
Gets the int value if an int value was set.
- getItems() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getItemsMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
-
Deprecated.See
PaginationInfo.getItemsMemberPath()
to retrieve the full path. - getItemsMemberPath() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
-
Get the resolved items path identifiers as a list of
MemberShape
. - 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
-
Deprecated.
- getKnowledge(Class<T>, Function<Model, T>) - Method in class software.amazon.smithy.model.Model
-
Gets a computed "knowledge index" of a specific type for the model and caches it for subsequent retrieval.
- getLabel(String) - Method in class software.amazon.smithy.model.pattern.SmithyPattern
-
Get a label by case-insensitive name.
- getLabels() - Method in class software.amazon.smithy.model.pattern.SmithyPattern
-
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.
- getListShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all lists in the Model.
- getListShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all lists in the Model that have a specific trait.
- getLocalTraits() - Method in class software.amazon.smithy.model.traits.MixinTrait
-
Gets the mixin local traits.
- getLocation() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getLocationName() - Method in class software.amazon.smithy.model.knowledge.HttpBinding
- getLocationType() - Method in class software.amazon.smithy.model.knowledge.TextInstance
-
Retrieves the type of TextLocationType associated with the text.
- getLongShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all longs in the Model.
- getLongShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all longs in the Model that have a specific trait.
- getMapShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all maps in the Model.
- getMapShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all maps in the Model that have a specific trait.
- 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.
- getMember(String) - Method in class software.amazon.smithy.model.shapes.Shape
-
Get a specific member by name.
- getMember(String, Function<Node, T>, Consumer<T>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
The same as
ObjectNode.expectMember(String, Function, Consumer)
, but the member is optional. - 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.
- getMemberNames() - Method in class software.amazon.smithy.model.shapes.Shape
-
Returns an ordered list of member names based on the order they are defined in the model, including mixin members.
- 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.
- getMemberShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all members in the Model.
- getMemberShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all members in the Model that have a specific trait.
- 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.
- getMessage() - Method in class software.amazon.smithy.model.traits.DeprecatedTrait
-
Gets the deprecation message value.
- getMessage() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- getMessage() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getMessageTemplate() - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
-
Gets the optional message template that can reference selector variables.
- 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.
- getMixins() - Method in class software.amazon.smithy.model.shapes.Shape
-
Get an ordered set of mixins attached to the shape.
- 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.
- getModelWithoutTraitShapes(Model, Predicate<Shape>) - 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.EnumDefinition
- getName() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- getName() - Method in class software.amazon.smithy.model.traits.PropertyTrait
- 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
- getName(ServiceShape) - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Get the name of the shape when it is used within the contextual closure of a service.
- getNamespace() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Get the namespace of the shape.
- 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 model.
- getNeighborShapeId() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the shape id of the neighbor shape.
- getNodeClass() - Method in enum class software.amazon.smithy.model.node.NodeType
-
Gets the
Node
class associated with the type. - getNoInlineDocumentSupport() - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
-
Checks if this protocol does not support inline documents.
- getNonLocalTraitsFromMap(Map<ShapeId, Trait>) - Static method in class software.amazon.smithy.model.traits.MixinTrait
-
Helper method used to filter out non-local traits from a map of traits.
- 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.
- getNumberMember(String, Consumer<Number>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
The same as
ObjectNode.expectNumberMember(String, Consumer)
but the member is optional. - 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.
- getObjectMember(String, Consumer<ObjectNode>) - 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.
- getOmitEmptyValues() - Method in class software.amazon.smithy.model.node.NodeMapper
-
Gets whether or not false, empty arrays, and empty objects are omitted from serialized POJOs.
- 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
- getOperationBindingType(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
-
Gets the identifier binding type of an operation to a resource.
- getOperationInputBindings(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.
- getOperationOutputBindings(ToShapeId, ToShapeId) - Method in class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
-
Gets a map of identifier names to output member names that provide a value for that identifier.
- getOperations() - Method in class software.amazon.smithy.model.shapes.EntityShape
-
Gets operations bound only through the "operations" property.
- getOperationShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all operations in the Model.
- getOperationShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all operations in the Model that have a specific trait.
- getOrigin() - Method in class software.amazon.smithy.model.traits.CorsTrait
- getOriginalId() - Method in class software.amazon.smithy.model.traits.synthetic.OriginalShapeIdTrait
-
Gets the original shape ID of the shape before it was renamed.
- 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
-
Gets the optional output structure of an operation, and returns an empty optional if the output targets
smithy.api#Unit
. - getOutputInfo(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.EventStreamIndex
-
Get event stream information for the output of an operation.
- getOutputMembers(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the output members of an operation as a map of member names to
MemberShape
. - getOutputPropertiesShape(OperationShape) - Method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
-
Resolves and returns the output shape of an operation that contains the top-level resource bound properties.
- getOutputShape() - Method in class software.amazon.smithy.model.shapes.OperationShape
-
Gets the output of the operation.
- getOutputShape(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Gets the optional output structure of an operation.
- getOutputToken() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- getOutputTokenMember() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
-
Deprecated.See
PaginationInfo.getOutputTokenMemberPath()
to retrieve the full path. - getOutputTokenMemberPath() - Method in class software.amazon.smithy.model.knowledge.PaginationInfo
-
Get the resolved output path identifiers as a list of
MemberShape
. - 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
- getParts() - Method in class software.amazon.smithy.model.node.NodePointer
-
Gets the parsed parts of the pointer.
- getPath() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- getPath(List<String>) - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Gets a property using a path to the property.
- getPattern() - Method in class software.amazon.smithy.model.traits.PatternTrait
-
Gets the regex pattern.
- getPrefix() - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait
- getProperties() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- getProperty(String) - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Gets a property from the attribute value.
- getPropertyName(ShapeId) - Method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
-
Gets the property name for a given member shape.
- getProtocols(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.ServiceIndex
-
Get all protocol traits attached to a service.
- getProvider() - Method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
-
Gets the precomputed neighbor provider.
- getProviderWithTraitRelationships() - Method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
-
Gets the neighbor provider that includes trait relationships.
- 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.traits.RecommendedTrait
-
Gets the reason it is recommended to set this member.
- getReason() - Method in interface software.amazon.smithy.model.validation.suppressions.Suppression
-
Gets the optional reason for the 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.
- getRename() - Method in class software.amazon.smithy.model.shapes.ServiceShape
- 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.
- getRequiredMixinMember(AbstractShapeBuilder<?, ?>, MemberShape, String) - Method in class software.amazon.smithy.model.shapes.Shape
- getResolved() - Method in exception software.amazon.smithy.model.loader.TopologicalShapeSort.CycleException
- 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
- getResourceShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all resources in the Model.
- getResourceShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all resources in the Model that have a specific trait.
- 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.
- getReverseProviderWithTraitRelationships() - Method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
-
Gets a reversed, bottom up neighbor provider that includes reverse traits.
- getScheme() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- getSegments() - Method in class software.amazon.smithy.model.pattern.SmithyPattern
-
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.
- getSelector() - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
-
Gets the required selector that matches shapes.
- getSelector() - Method in class software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator.Config
-
Gets the selector that if no shapes match, a validation event is emitted.
- 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 class 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. - getSerializeNullValues() - Method in class software.amazon.smithy.model.node.NodeMapper
- 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.
- getServiceShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all services in the Model.
- getServiceShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all services in the Model that have a specific trait.
- getSetShapes() - Method in class software.amazon.smithy.model.Model
-
Deprecated.
- getSetShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Deprecated.
- getSeverity() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- getSeverity() - Method in class software.amazon.smithy.model.validation.ValidationEvent
- getShape() - Method in class software.amazon.smithy.model.knowledge.TextInstance
-
Gets the shape associated with the text.
- getShape() - Method in class software.amazon.smithy.model.neighbor.Relationship
-
Gets the starting shape in the relationship.
- getShape() - Method in class software.amazon.smithy.model.selector.Selector.ShapeMatch
-
Gets the matching shape.
- getShape(ShapeId) - Method in class software.amazon.smithy.model.Model
- getShapeClass() - Method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Gets the class that implements this shape type.
- 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
-
Deprecated.
- getShapeId() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- getShapeId() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait.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.MixinTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.PropertyTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.RangeTrait.Provider
- getShapeId() - Method in class software.amazon.smithy.model.traits.RecommendedTrait.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.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
- getShapeIds() - Method in class software.amazon.smithy.model.Model
-
Gets the immutable set of
ShapeId
in the model. - 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.
- getShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets a set of shapes in the model marked with a specific trait.
- getShapesWithTrait(ToShapeId) - Method in class software.amazon.smithy.model.Model
-
Gets a set of shapes in the model marked with a specific trait.
- 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.EnumShape.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.IntEnumShape.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
-
Deprecated.
- 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
- getShortShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all shorts in the Model.
- getShortShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all shorts in the Model that have a specific trait.
- 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.traits.AnnotationTrait
- 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
. - getStreamingTrait() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the event stream trait.
- 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.
- getStringMember(String, Consumer<String>) - Method in class software.amazon.smithy.model.node.ObjectNode
-
The same as
ObjectNode.expectStringMember(String, Consumer)
but the member is optional. - 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.
- getStringRepresentation() - Method in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
- getStringShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all strings in the Model.
- getStringShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all strings in the Model that have a specific trait.
- getStringValue() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
-
Gets the string value if a string value was set.
- getStructurallyExclusive() - Method in class software.amazon.smithy.model.traits.TraitDefinition
-
Gets the
structurallyExclusive
property of the trait. - getStructure() - Method in class software.amazon.smithy.model.knowledge.EventStreamInfo
-
Gets the input or output structure of the data.
- getStructureShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all structures in the Model.
- getStructureShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all structures in the Model that have a specific trait.
- 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.EnumDefinition
- getTarget() - Method in class software.amazon.smithy.model.shapes.MemberShape.Builder
- getTarget() - Method in class software.amazon.smithy.model.shapes.MemberShape
-
Get the targeted member shape ID.
- getText() - Method in class software.amazon.smithy.model.knowledge.TextInstance
-
Retrieves the text content of the TextInstance.
- getTextInstances() - Method in class software.amazon.smithy.model.knowledge.TextIndex
- getThrottling() - Method in class software.amazon.smithy.model.traits.RetryableTrait
- getTimestampShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all timestamps in the Model.
- getTimestampShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all timestamps in the Model that have a specific trait.
- getTitle() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- getTrait() - Method in class software.amazon.smithy.model.knowledge.TextInstance
-
Gets the trait associated with the text.
- getTrait(Class<T>) - Method in class software.amazon.smithy.model.shapes.Shape
-
Attempt to retrieve a specific
Trait
by class from the shape. - getTraitDefinition(ToShapeId) - Method in class software.amazon.smithy.model.Model
-
Gets the trait definition of a specific trait shape ID.
- getTraitPropertyPath() - Method in class software.amazon.smithy.model.knowledge.TextInstance
-
Gets the ordered path components within a trait's value the text is associated with.
- getTraits() - Method in class software.amazon.smithy.model.traits.AuthDefinitionTrait
-
Gets the list of shape IDs that auth implementations must know about in order to successfully utilize the auth scheme.
- getTraits() - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
-
Gets the list of shape IDs that protocol implementations must know about in order to successfully utilize the protocol.
- 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.BigDecimalShape
- getType() - Method in class software.amazon.smithy.model.shapes.BigIntegerShape
- getType() - Method in class software.amazon.smithy.model.shapes.BlobShape
- getType() - Method in class software.amazon.smithy.model.shapes.BooleanShape
- getType() - Method in class software.amazon.smithy.model.shapes.ByteShape
- getType() - Method in class software.amazon.smithy.model.shapes.DocumentShape
- getType() - Method in class software.amazon.smithy.model.shapes.DoubleShape
- getType() - Method in class software.amazon.smithy.model.shapes.EnumShape
- getType() - Method in class software.amazon.smithy.model.shapes.FloatShape
- getType() - Method in class software.amazon.smithy.model.shapes.IntegerShape
- getType() - Method in class software.amazon.smithy.model.shapes.IntEnumShape
- getType() - Method in class software.amazon.smithy.model.shapes.ListShape
- getType() - Method in class software.amazon.smithy.model.shapes.LongShape
- getType() - Method in class software.amazon.smithy.model.shapes.MapShape
- getType() - Method in class software.amazon.smithy.model.shapes.MemberShape
- getType() - Method in class software.amazon.smithy.model.shapes.OperationShape
- getType() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- getType() - Method in class software.amazon.smithy.model.shapes.ServiceShape
- getType() - Method in class software.amazon.smithy.model.shapes.SetShape
-
Deprecated.
- getType() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets the type of the shape.
- getType() - Method in class software.amazon.smithy.model.shapes.ShortShape
- getType() - Method in class software.amazon.smithy.model.shapes.StringShape
- getType() - Method in class software.amazon.smithy.model.shapes.StructureShape
- getType() - Method in class software.amazon.smithy.model.shapes.TimestampShape
- getType() - Method in class software.amazon.smithy.model.shapes.UnionShape
- getUnionShapes() - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all unions in the Model.
- getUnionShapesWithTrait(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable set of all unions in the Model that have a specific trait.
- getUnmatchedEvents() - Method in class software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
- getUnresolved() - Method in exception software.amazon.smithy.model.loader.TopologicalShapeSort.CycleException
-
Gets the entire set of shapes that could not be resolved.
- 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
- getUrls() - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait
-
Gets the external documentation names and links.
- 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.
- 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.EnumDefinition
- getValue() - Method in class software.amazon.smithy.model.traits.StringTrait
- getValue(Node) - Method in class software.amazon.smithy.model.node.NodePointer
-
Gets a value from a container shape at the pointer location.
- getValues() - Method in class software.amazon.smithy.model.traits.AuthTrait
-
Deprecated.
- getValues() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.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
- getValueSet() - Method in class software.amazon.smithy.model.traits.AuthTrait
-
Gets the auth scheme trait values.
- getVersion() - Method in class software.amazon.smithy.model.shapes.ServiceShape
-
Get the version of the service.
- getWhenMissingSetter() - Method in class software.amazon.smithy.model.node.NodeMapper
- GREEDY_LABEL - Enum constant in enum class software.amazon.smithy.model.pattern.SmithyPattern.Segment.Type
H
- handle(Type, String, String, Node) - Method in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Invoked when an object property cannot be deserialized.
- 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.NodePointer
- 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.SmithyPattern
- hashCode() - Method in class software.amazon.smithy.model.pattern.SmithyPattern.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.SourceLocation
- hashCode() - Method in class software.amazon.smithy.model.traits.AbstractTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.AnnotationTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.CorsTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.EnumDefinition
- hashCode() - Method in class software.amazon.smithy.model.traits.HttpTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- hashCode() - Method in class software.amazon.smithy.model.traits.RetryableTrait
- hashCode() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- hashCode() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- 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.
- hasMember() - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Checks if the ID has a member set.
- hasMember(String) - Method in class software.amazon.smithy.model.node.ObjectNode.Builder
- hasNames() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.Checks if all of the constants of an enum define a name.
- hasProperties() - Method in class software.amazon.smithy.model.shapes.ResourceShape
- hasRequestBody(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns true if the request has a modeled body.
- hasResponseBody(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
-
Returns true if the response has a modeled body.
- 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 - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- HEADER - Enum constant in enum class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.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(ObjectNode) - 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 - Enum constant in enum class software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- HTTP_DATE - Static variable in class software.amazon.smithy.model.traits.TimestampFormatTrait
- HttpApiKeyAuthTrait - Class in software.amazon.smithy.model.traits
-
An HTTP-specific authentication scheme that sends an arbitrary API key in a header or query string parameter.
- HttpApiKeyAuthTrait.Builder - Class in software.amazon.smithy.model.traits
- HttpApiKeyAuthTrait.Location - Enum Class in software.amazon.smithy.model.traits
- HttpApiKeyAuthTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpApiKeyAuthTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that if an HttpApiKeyAuth trait's scheme field is present then the 'in' field must specify "header".
- HttpApiKeyAuthTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpApiKeyAuthTraitValidator
- HttpBasicAuthTrait - Class in software.amazon.smithy.model.traits
-
An auth scheme trait uses HTTP basic auth.
- HttpBasicAuthTrait() - Constructor for class software.amazon.smithy.model.traits.HttpBasicAuthTrait
- HttpBasicAuthTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpBasicAuthTrait
- HttpBasicAuthTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpBearerAuthTrait - Class in software.amazon.smithy.model.traits
-
An auth scheme trait uses HTTP bearer auth.
- HttpBearerAuthTrait() - Constructor for class software.amazon.smithy.model.traits.HttpBearerAuthTrait
- HttpBearerAuthTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpBearerAuthTrait
- HttpBearerAuthTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpBinding - Class in software.amazon.smithy.model.knowledge
-
Defines an HTTP message member binding.
- HttpBinding.Location - Enum Class 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
- HttpChecksumRequiredTrait - Class in software.amazon.smithy.model.traits
-
Indicates that an operation requires a checksum in its HTTP request.
- HttpChecksumRequiredTrait() - Constructor for class software.amazon.smithy.model.traits.HttpChecksumRequiredTrait
- HttpChecksumRequiredTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpChecksumRequiredTrait
- HttpChecksumRequiredTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpDigestAuthTrait - Class in software.amazon.smithy.model.traits
-
An auth scheme trait uses HTTP digest auth.
- HttpDigestAuthTrait() - Constructor for class software.amazon.smithy.model.traits.HttpDigestAuthTrait
- HttpDigestAuthTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpDigestAuthTrait
- HttpDigestAuthTrait.Provider - Class in software.amazon.smithy.model.traits
- 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(ObjectNode) - 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(ObjectNode) - 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
- HttpQueryParamsTrait - Class in software.amazon.smithy.model.traits
-
Binds a map structure member to the HTTP query string.
- HttpQueryParamsTrait() - Constructor for class software.amazon.smithy.model.traits.HttpQueryParamsTrait
- HttpQueryParamsTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpQueryParamsTrait
- HttpQueryParamsTrait.Provider - Class in software.amazon.smithy.model.traits
- HttpQueryParamsTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
When the `httpQueryParams` trait is used, this validator emits a NOTE when another member of the container shape applies the `httpQuery` trait which may result in a conflict within the query string.
- HttpQueryParamsTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpQueryParamsTraitValidator
- 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
- HttpResponseCodeTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the structure member represents the HTTP response status code.
- HttpResponseCodeTrait() - Constructor for class software.amazon.smithy.model.traits.HttpResponseCodeTrait
- HttpResponseCodeTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.HttpResponseCodeTrait
- HttpResponseCodeTrait.Provider - Class in software.amazon.smithy.model.traits
- 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
- HttpUriFormatValidator - Class in software.amazon.smithy.model.validation.validators
- HttpUriFormatValidator() - Constructor for class software.amazon.smithy.model.validation.validators.HttpUriFormatValidator
I
- id(String) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the shape ID of the shape.
- id(String) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- id(String) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- id(String) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the required event ID of the event.
- id(ShapeId) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates an 'id'
AttributeValue
from a shape ID. - id(ShapeId) - 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.CollectionShape.Builder
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.MapShape.Builder
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- id(ShapeId) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- ID - Static variable in class software.amazon.smithy.model.traits.AuthDefinitionTrait
- ID - Static variable in class software.amazon.smithy.model.traits.AuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.BoxTrait
-
Deprecated.
- ID - Static variable in class software.amazon.smithy.model.traits.ClientOptionalTrait
- ID - Static variable in class software.amazon.smithy.model.traits.CorsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.DefaultTrait
- 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
-
Deprecated.
- ID - Static variable in class software.amazon.smithy.model.traits.EnumValueTrait
- 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.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.HttpApiKeyAuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpBasicAuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpBearerAuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpChecksumRequiredTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpDigestAuthTrait
- 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.HttpQueryParamsTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpQueryTrait
- ID - Static variable in class software.amazon.smithy.model.traits.HttpResponseCodeTrait
- 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.InputTrait
- ID - Static variable in class software.amazon.smithy.model.traits.InternalTrait
- 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.MixinTrait
- ID - Static variable in class software.amazon.smithy.model.traits.NestedPropertiesTrait
- ID - Static variable in class software.amazon.smithy.model.traits.NoReplaceTrait
- ID - Static variable in class software.amazon.smithy.model.traits.NotPropertyTrait
- ID - Static variable in class software.amazon.smithy.model.traits.OptionalAuthTrait
- ID - Static variable in class software.amazon.smithy.model.traits.OutputTrait
- 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.PropertyTrait
- ID - Static variable in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
- 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.RecommendedTrait
- 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.RequiresLengthTrait
- 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.SparseTrait
- ID - Static variable in class software.amazon.smithy.model.traits.StreamingTrait
- ID - Static variable in class software.amazon.smithy.model.traits.SuppressTrait
- ID - Static variable in class software.amazon.smithy.model.traits.synthetic.OriginalShapeIdTrait
- ID - Static variable in class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait
- 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.UnitTypeTrait
-
The unitType shape ID.
- ID - Static variable in class software.amazon.smithy.model.traits.UnstableTrait
- 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(ObjectNode) - 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(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.IdempotentTrait
- IdempotentTrait.Provider - Class in software.amazon.smithy.model.traits
- IDENTIFIER - Enum constant in enum class 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 Class 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.
- 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
- in(HttpApiKeyAuthTrait.Location) - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Builder
- includePrelude(boolean) - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
-
Enables or disables including the prelude in the serialized model.
- INGORE - Enum constant in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Ignores unknown properties.
- 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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - inputToken(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- InputTrait - Class in software.amazon.smithy.model.traits
-
Specializes a structure as the input of a single operation.
- InputTrait() - Constructor for class software.amazon.smithy.model.traits.InputTrait
- InputTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.InputTrait
- InputTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.InputTrait
- InputTrait.Provider - Class in software.amazon.smithy.model.traits
- INSTANCE - Enum constant in enum class software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Indicates that the operation is bound to a resource as an instance operation.
- INSTANCE_OPERATION - Enum constant in enum class 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.
- INT_ENUM - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- INT_ENUM_MEMBER - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
intEnum
shapes to theirmember shapes
. - INTEGER - Enum constant in enum class 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
. - intEnumShape(IntEnumShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
- IntEnumShape - Class in software.amazon.smithy.model.shapes
- IntEnumShape.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create a
IntegerShape
. - InternalTrait - Class in software.amazon.smithy.model.traits
-
Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.
- InternalTrait() - Constructor for class software.amazon.smithy.model.traits.InternalTrait
- InternalTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.InternalTrait
- InternalTrait.Provider - Class in software.amazon.smithy.model.traits
- intValue(int) - Method in class software.amazon.smithy.model.traits.EnumValueTrait.Builder
- 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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipDirection
-
The relationship goes from a shape to the shape that defines a directed relationship to the shape.
- isAlphabetic(char) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Returns true if the given character is an alphabetic character A-Z, a-z.
- 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
-
Deprecated.
- 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
- isDeprecated() - Method in class software.amazon.smithy.model.traits.EnumDefinition
- isDigit(char) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Returns true if the given value is a digit 0-9.
- 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.
- isEnumShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isEventStream(Model, MemberShape) - Static method in class software.amazon.smithy.model.traits.StreamingTrait
-
Determines whether a given member targets an event stream.
- isEventStream(Shape) - Static method in class software.amazon.smithy.model.traits.StreamingTrait
-
Determines whether a given shape is an event stream.
- 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.SmithyPattern.Segment
- isIdentifierStart(char) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Returns true if the given character is allowed to start an identifier.
- isInputStructure(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Returns true if the given structure is used as input by any operation in the model or is marked with the input trait.
- isIntegerShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isIntEnumShape() - 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.SmithyPattern.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
- isMemberNullable(MemberShape) - Method in class software.amazon.smithy.model.knowledge.NullableIndex
-
Checks if a member is nullable using
NullableIndex.CheckMode.CLIENT
. - isMemberNullable(MemberShape, NullableIndex.CheckMode) - Method in class software.amazon.smithy.model.knowledge.NullableIndex
-
Checks if a member is nullable using v2 nullability rules.
- isMemberShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isMemberShapeProperty(MemberShape) - Method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
-
Returns true if a member shape positively maps to a property.
- isNaturalNumber() - Method in class software.amazon.smithy.model.node.NumberNode
-
Returns true if the node contains a natural number.
- isNullable(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.NullableIndex
-
Deprecated.
- 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
- isOutputStructure(ToShapeId) - Method in class software.amazon.smithy.model.knowledge.OperationIndex
-
Returns true if the given structure is used as output by any operation in the model or is marked with the output trait.
- isPreludeShape(ToShapeId) - Static method in class software.amazon.smithy.model.loader.Prelude
-
Checks if the given shape ID is defined by the prelude.
- isPresent() - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Checks if the attribute value is considered present.
- 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
-
Deprecated.
- isShapeType(ShapeType) - Method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Returns whether this shape type is equivalent to the given shape type, accounting for things like enums being considered specializations of strings.
- isShortShape() - Method in class software.amazon.smithy.model.shapes.Shape
- 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
- isStructurallyExclusiveByMember() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- isStructurallyExclusiveByTarget() - Method in class software.amazon.smithy.model.traits.TraitDefinition
- isStructureShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isSynthetic() - Method in class software.amazon.smithy.model.traits.BoxTrait
-
Deprecated.
- isSynthetic() - Method in class software.amazon.smithy.model.traits.synthetic.OriginalShapeIdTrait
- isSynthetic() - Method in class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait
- isSynthetic() - Method in interface software.amazon.smithy.model.traits.Trait
-
Checks if this trait is persisted with the shape, or if it is a synthetic, or transient trait, only meant to temporarily aid in some kind of in-memory model transformation.
- isTimestampShape() - Method in class software.amazon.smithy.model.shapes.Shape
- isTraitApplied(Class<? extends Trait>) - Method in class software.amazon.smithy.model.Model
-
Returns true if the given trait shape ID was used in the model.
- 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.
- isValidIdentifierCharacter(char) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Returns true if the given character is allowed in an 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
- iterateShapes(Shape) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Lazily iterates over all of the relationships in the closure of the given shape, including the given shape.
- iterateShapes(Shape, Predicate<Relationship>) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Lazily iterates over all of the unique shapes in the closure of the given shape, including the given shape.
- iterator() - Method in class software.amazon.smithy.model.node.ArrayNode
- iterator() - Method in class software.amazon.smithy.model.selector.PathFinder.Path
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
- JsonNameValidator - Class in software.amazon.smithy.model.validation.validators
- JsonNameValidator() - Constructor for class software.amazon.smithy.model.validation.validators.JsonNameValidator
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
-
A marker interface used to indicate that a class contains an index of computed knowledge about a
Model
.
L
- LABEL - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- LABEL - Enum constant in enum class software.amazon.smithy.model.pattern.SmithyPattern.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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the list lifecycle operation.
- LIST - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- LIST_MEMBER - Enum constant in enum class 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(Object) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates an
AttributeValue
that contains a literal value. - LITERAL - Enum constant in enum class software.amazon.smithy.model.pattern.SmithyPattern.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.
- localTraits(Collection<ShapeId>) - Method in class software.amazon.smithy.model.traits.MixinTrait.Builder
- LONG - Enum constant in enum class 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 - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- MAP_KEY - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
map
shapes. - MAP_VALUE - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
map
shapes. - 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.
- matches(Model) - Method in interface software.amazon.smithy.model.selector.Selector
-
Returns a stream of
Selector.ShapeMatch
objects for each match found in a model. - 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
- MediaTypeValidator - Class in software.amazon.smithy.model.validation.validators
- MediaTypeValidator() - Constructor for class software.amazon.smithy.model.validation.validators.MediaTypeValidator
- member(MemberShape) - Method in class software.amazon.smithy.model.shapes.CollectionShape.Builder
-
Sets the member of the collection.
- member(MemberShape) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- member(ShapeId) - 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.SetShape.Builder
-
Deprecated.
- member(ShapeId, Consumer<MemberShape.Builder>) - 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.SetShape.Builder
-
Deprecated.
- MEMBER - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType.Category
- MEMBER - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- MEMBER - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
-
The trait can only be applied to a single member of a structure.
- MEMBER_CONTAINER - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships exist on
member
shapes. - MEMBER_TARGET - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships exist on
member
shapes. - members - Variable in class software.amazon.smithy.model.shapes.UnionShape.Builder
- members() - Method in class software.amazon.smithy.model.shapes.Shape
-
Gets all the members contained in the shape.
- members(Collection<MemberShape>) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Replaces the members of the builder.
- members(Collection<MemberShape>) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
-
Replaces the members of the builder.
- members(Collection<MemberShape>) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
-
Replaces the members of the builder.
- 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.Builder
- 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.
- metadataFilter(Predicate<String>) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.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
- MIXIN - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationship that exists between a structure or union and a mixin applied to the shape.
- mixins(Collection<? extends Shape>) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Replaces the mixins of the shape.
- MixinTrait - Class in software.amazon.smithy.model.traits
- MixinTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create a MixinTrait.
- MixinTrait.Provider - Class in software.amazon.smithy.model.traits
- MixinValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that mixins do not introduce conflicting members across mixin closures.
- MixinValidator() - Constructor for class software.amazon.smithy.model.validation.validators.MixinValidator
- model() - Method in class software.amazon.smithy.model.validation.node.NodeValidatorPlugin.Context
-
Get the model being evaluated.
- model(Model) - Method in class software.amazon.smithy.model.selector.Selector.Runner
-
Deprecated.
- 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 that contains shapes, traits, metadata, and various computed information used to interpret the model.
- MODEL_DEPRECATION - Static variable in interface software.amazon.smithy.model.validation.Validator
-
Event ID used when something in the model is deprecated.
- 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, 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.
- ModelTransformException - Exception in software.amazon.smithy.model.transform
-
Exception thrown when a model transformation error occurs.
- ModelTransformException(String) - Constructor for exception software.amazon.smithy.model.transform.ModelTransformException
- ModelTransformException(String, Throwable) - Constructor for exception software.amazon.smithy.model.transform.ModelTransformException
N
- name(String) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- name(String) - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Builder
- name(String) - Method in class software.amazon.smithy.model.traits.PropertyTrait.Builder
- NAMESPACE - Enum constant in enum class software.amazon.smithy.model.knowledge.TextInstance.TextLocationType
- NAMESPACE - Static variable in class software.amazon.smithy.model.loader.Prelude
-
The Smithy prelude namespace.
- NAN - Enum constant in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
- NEGATIVE_INFINITY - Enum constant in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
- 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
- NestedPropertiesTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the contents of a structure member contain the top-level properties of the associated resource.
- NestedPropertiesTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.NestedPropertiesTrait
- NestedPropertiesTrait.Provider - Class in software.amazon.smithy.model.traits
- node(Node) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates a 'node'
AttributeValue
for aNode
. - Node - Class in software.amazon.smithy.model.node
-
Base class of for all Smithy model nodes.
- Node.NonNumericFloat - Enum Class in software.amazon.smithy.model.node
-
Non-numeric values for floats and doubles.
- NodeDeserializationException - Exception in software.amazon.smithy.model.node
-
Exception encountered during deserialization.
- NodeDeserializationException(String, SourceLocation) - Constructor for exception software.amazon.smithy.model.node.NodeDeserializationException
- NodeDeserializationException(String, SourceLocation, Throwable) - Constructor for exception software.amazon.smithy.model.node.NodeDeserializationException
- NodeHandler - Class in software.amazon.smithy.model.node.internal
- NodeHandler() - Constructor for class software.amazon.smithy.model.node.internal.NodeHandler
- NodeMapper - Class in software.amazon.smithy.model.node
-
Serializes and deserializes Smithy
Node
values to/from objects. - NodeMapper() - Constructor for class software.amazon.smithy.model.node.NodeMapper
- NodeMapper.WhenMissing - Enum Class in software.amazon.smithy.model.node
-
Specifies the behavior of the mapper when attempting to deserialize an unknown property.
- NodePointer - Class in software.amazon.smithy.model.node
-
JSON Pointer abstraction over Smithy
Node
values. - NodeSerializationException - Exception in software.amazon.smithy.model.node
-
Exception encountered during serialization.
- NodeSerializationException(String) - Constructor for exception software.amazon.smithy.model.node.NodeSerializationException
- NodeSerializationException(String, Throwable) - Constructor for exception software.amazon.smithy.model.node.NodeSerializationException
- NodeType - Enum Class 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
- NodeValidatorPlugin.Context - Class in software.amazon.smithy.model.validation.node
-
Validation context to pass to each NodeValidatorPlugin.
- 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. - noInlineDocumentSupport(boolean) - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.Builder
- NoInlineDocumentSupportValidator - Class in software.amazon.smithy.model.validation.validators
-
Detects when a protocol indicates that it does not support inline documents, yet the protocol trait is attached to a service that uses inline documents.
- NoInlineDocumentSupportValidator() - Constructor for class software.amazon.smithy.model.validation.validators.NoInlineDocumentSupportValidator
- none() - Static method in class software.amazon.smithy.model.SourceLocation
-
Creates an empty source location.
- NONE - Enum constant in enum class 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
- NoReplaceTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.
- NoReplaceTrait() - Constructor for class software.amazon.smithy.model.traits.NoReplaceTrait
- NoReplaceTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.NoReplaceTrait
- NoReplaceTrait.Provider - Class in software.amazon.smithy.model.traits
- 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 - Enum constant in enum class software.amazon.smithy.model.validation.Severity
- NotPropertyTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a top level input/output structure member is not associated with a resource property.
- NotPropertyTrait() - Constructor for class software.amazon.smithy.model.traits.NotPropertyTrait
- NotPropertyTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.NotPropertyTrait
- NotPropertyTrait.Provider - Class in software.amazon.smithy.model.traits
- NULL - Enum constant in enum class software.amazon.smithy.model.node.NodeType
- NullableIndex - Class in software.amazon.smithy.model.knowledge
-
An index that checks if a member is nullable.
- NullableIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.NullableIndex
- NullableIndex.CheckMode - Enum Class in software.amazon.smithy.model.knowledge
-
Defines the type of model consumer to assume when determining if a member should be considered nullable or always present.
- 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 - Enum constant in enum class 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 - Enum constant in enum class 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 class software.amazon.smithy.model.knowledge.BottomUpIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.BoxIndex
-
Deprecated.
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.EventStreamIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.HttpBindingIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.IdentifierBindingIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.NeighborProviderIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.NullableIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.OperationIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.PaginatedIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.PropertyBindingIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.ServiceIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.TextIndex
- of(Model) - Static method in class software.amazon.smithy.model.knowledge.TopDownIndex
- of(Model) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Creates a default NeighborProvider for the given model.
- 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.CleanServiceRenames
- 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.CleanTraitDefinitions
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.RemoveMixins
- onRemove(ModelTransformer, Collection<Shape>, Model) - Method in class software.amazon.smithy.model.transform.plugins.RemoveTraits
- OPERATION - Enum constant in enum class 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 - Enum constant in enum class 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
. - OperationValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates operation inputs, outputs, and the use of
input
andoutput
traits. - OperationValidator() - Constructor for class software.amazon.smithy.model.validation.validators.OperationValidator
- OptionalAuthTrait - Class in software.amazon.smithy.model.traits
-
Indicates that an operation / service supports unauthenticated access.
- OptionalAuthTrait() - Constructor for class software.amazon.smithy.model.traits.OptionalAuthTrait
- OptionalAuthTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.OptionalAuthTrait
- OptionalAuthTrait.Provider - Class in software.amazon.smithy.model.traits
- orderedTickedList(Collection<?>) - Static method in class software.amazon.smithy.model.validation.ValidationUtils
-
Creates a comma separated string made up of the given collection.
- origin(String) - Method in class software.amazon.smithy.model.traits.CorsTrait.Builder
- OriginalShapeIdTrait - Class in software.amazon.smithy.model.traits.synthetic
-
Used to provide the original shape ID of a shape that is renamed in the semantic model.
- OriginalShapeIdTrait(ShapeId) - Constructor for class software.amazon.smithy.model.traits.synthetic.OriginalShapeIdTrait
- 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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist on
operation
shapes. - outputToken(String) - Method in class software.amazon.smithy.model.traits.PaginatedTrait.Builder
- OutputTrait - Class in software.amazon.smithy.model.traits
-
Specializes a structure as the output of a single operation.
- OutputTrait() - Constructor for class software.amazon.smithy.model.traits.OutputTrait
- OutputTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.OutputTrait
- OutputTrait(SourceLocation) - Constructor for class software.amazon.smithy.model.traits.OutputTrait
- OutputTrait.Provider - Class in software.amazon.smithy.model.traits
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.node.NodePointer
-
Parses a JSON pointer.
- 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.SmithyPattern.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.
- parse(String, String, boolean) - Static method in class software.amazon.smithy.model.node.internal.NodeHandler
- parseIdentifier(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Expects and returns a parsed Smithy identifier production.
- 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.
- parseNumber(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Parses a Smithy number production into a string.
- parseRootShapeId(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Expects and returns a parsed absolute Smithy Shape ID that does not include a member.
- ParserUtils - Class in software.amazon.smithy.model.loader
-
Utility methods that act on a
SimpleParser
and parse Smithy grammar productions. - parseScopedAttribute(SimpleParser) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Uses the given parser to parse a scoped attribute production.
- parseShapeId(SimpleParser) - Static method in class software.amazon.smithy.model.loader.ParserUtils
-
Expects and returns a parsed relative or absolute Smithy Shape ID.
- 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.SmithyPattern.Builder
- 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
- PatternTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Emits a validation event if a pattern trait is not anchored.
- PatternTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.PatternTraitValidator
- PAYLOAD - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- placeShapesByNamespace(Shape) - Static method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer
-
Sorts shapes into files based on their namespace, where each file is named {namespace}.smithy.
- POSITIVE_INFINITY - Enum constant in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
- 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.
- prefix(String) - Method in class software.amazon.smithy.model.traits.XmlNamespaceTrait.Builder
- PREFIX_HEADERS - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- Prelude - Class in software.amazon.smithy.model.loader
-
Represents the prelude model available to every Smithy model.
- PRESENCE - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Emit when a trait is added or removed.
- prettyPrint(Node, String) - Static method in class software.amazon.smithy.model.node.internal.NodeHandler
- prettyPrintJson(Node) - Static method in class software.amazon.smithy.model.node.Node
-
Writes the contents of a Node to a pretty-printed JSON string.
- prettyPrintJson(Node, String) - Static method in class software.amazon.smithy.model.node.Node
-
Writes the contents of a Node to a pretty-printed JSON string.
- print(Node) - Static method in class software.amazon.smithy.model.node.internal.NodeHandler
- 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(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.PrivateTrait
- PrivateTrait.Provider - Class in software.amazon.smithy.model.traits
- projection(Collection<AttributeValue>) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates a 'projection'
AttributeValue
. - properties(Map<String, ShapeId>) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- PROPERTY - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a
member
and the shapes that are referenced by its properties property. - PropertyBindingIndex - Class in software.amazon.smithy.model.knowledge
-
Index of member shape to associated resource property information.
- PropertyTrait - Class in software.amazon.smithy.model.traits
-
Configures how a structure member maps to a resource property.
- PropertyTrait.Builder - Class in software.amazon.smithy.model.traits
- PropertyTrait.Provider - Class in software.amazon.smithy.model.traits
- ProtocolDefinitionTrait - Class in software.amazon.smithy.model.traits
-
A trait that is attached to other traits to define a Smithy protocol.
- ProtocolDefinitionTrait(ProtocolDefinitionTrait.Builder) - Constructor for class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
- ProtocolDefinitionTrait.Builder - Class in software.amazon.smithy.model.traits
- ProtocolDefinitionTrait.Provider - Class in software.amazon.smithy.model.traits
- Provider() - Constructor for class software.amazon.smithy.model.traits.AuthDefinitionTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.AuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.BoxTrait.Provider
-
Deprecated.
- Provider() - Constructor for class software.amazon.smithy.model.traits.ClientOptionalTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.CorsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.DefaultTrait.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
-
Deprecated.
- Provider() - Constructor for class software.amazon.smithy.model.traits.EnumValueTrait.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.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.HttpApiKeyAuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpBasicAuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpBearerAuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpChecksumRequiredTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpDigestAuthTrait.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.HttpQueryParamsTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpQueryTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.HttpResponseCodeTrait.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.InputTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.InternalTrait.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.MixinTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.NestedPropertiesTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.NoReplaceTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.NotPropertyTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.OptionalAuthTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.OutputTrait.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.PropertyTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.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.RecommendedTrait.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.RequiresLengthTrait.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.SparseTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.StreamingTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.SuppressTrait.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.UnitTypeTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.model.traits.UnstableTrait.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() - Constructor for class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator.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<ObjectNode, T>) - Constructor for class software.amazon.smithy.model.traits.AnnotationTrait.Provider
- put(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ResourceShape.Builder
- PUT - Enum constant in enum class 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.
- putRename(ShapeId, String) - Method in class software.amazon.smithy.model.shapes.ServiceShape.Builder
Q
- QUERY - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- QUERY - Enum constant in enum class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Location
- QUERY_PARAMS - Enum constant in enum class 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 RangeTrait.
- RangeTrait.Provider - Class in software.amazon.smithy.model.traits
- 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 - Enum constant in enum class 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(ObjectNode) - 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.traits.RecommendedTrait.Builder
- RecommendedTrait - Class in software.amazon.smithy.model.traits
- RecommendedTrait.Builder - Class in software.amazon.smithy.model.traits
-
Builder used to create a RecommendedTrait.
- RecommendedTrait.Provider - Class in software.amazon.smithy.model.traits
- 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 Class in software.amazon.smithy.model.neighbor
-
Defines the directionality of a relationship.
- relationshipFilter(Predicate<Relationship>) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Sets a predicate function to prevents traversing specific relationships.
- RelationshipType - Enum Class in software.amazon.smithy.model.neighbor
-
Defines the relationship types between neighboring shapes.
- REMOVE - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Emit when a trait or value is removed.
- 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
-
Deprecated.
- removeEnumByName(String) - Method in class software.amazon.smithy.model.traits.EnumTrait.Builder
-
Deprecated.
- removeError(ToShapeId) - Method in class software.amazon.smithy.model.shapes.OperationShape.Builder
-
Removes an error by Shape ID.
- removeError(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ServiceShape.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.
- removeMember(String) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Removes a member by name.
- removeMember(String) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
-
Removes a member by name.
- removeMember(String) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
-
Removes a member by name.
- removeMetadataProperty(String) - Method in class software.amazon.smithy.model.Model.Builder
- removeMixin(ToShapeId) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes a mixin from the shape by shape or ID.
- removeMixin(ToShapeId) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
- removeMixin(ToShapeId) - Method in class software.amazon.smithy.model.shapes.IntEnumShape.Builder
- removeMixin(ToShapeId) - Method in class software.amazon.smithy.model.shapes.UnionShape.Builder
- RemoveMixins - Class in software.amazon.smithy.model.transform.plugins
-
Removes mixins from shapes when a mixin is removed from the model.
- RemoveMixins() - Constructor for class software.amazon.smithy.model.transform.plugins.RemoveMixins
- 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.
- removeRename(ToShapeId) - Method in class software.amazon.smithy.model.shapes.ServiceShape.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.
- removeShapes(Model, Collection<? extends 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.
- removeTrait(String) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Removes a trait from the shape builder.
- removeTrait(String) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- removeTrait(ShapeId) - 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.SetShape.Builder
-
Deprecated.
- 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.
- removeUrl(String) - Method in class software.amazon.smithy.model.traits.ExternalDocumentationTrait.Builder
- removeValue(String) - Method in class software.amazon.smithy.model.traits.StringListTrait.Builder
-
Removes a value from the builder.
- rename(Map<ShapeId, String>) - Method in class software.amazon.smithy.model.shapes.ServiceShape.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<? extends 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(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.RequiredTrait
- RequiredTrait.Provider - Class in software.amazon.smithy.model.traits
- RequiresLengthTrait - Class in software.amazon.smithy.model.traits
-
Indicates that the streaming blob must be finite and has a known size.
- RequiresLengthTrait() - Constructor for class software.amazon.smithy.model.traits.RequiresLengthTrait
- RequiresLengthTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.RequiresLengthTrait
- RequiresLengthTrait.Provider - Class in software.amazon.smithy.model.traits
- reset() - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Resets the state of the ModelAssembler.
- resolveFullPath(String, Model, StructureShape) - Static method in class software.amazon.smithy.model.traits.PaginatedTrait
-
Resolves an output path to a list of
MemberShape
. - resolvePath(String, Model, StructureShape) - Static method in class software.amazon.smithy.model.traits.PaginatedTrait
-
Deprecated.This method only returns the last
MemberShape
of an output path. To resolve each path identifier to it's respectiveMemberShape
seePaginatedTrait.resolveFullPath(java.lang.String, software.amazon.smithy.model.Model, software.amazon.smithy.model.shapes.StructureShape)
- resource(ShapeId) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- RESOURCE - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
A resource relationship exists between a service or resource and the resources bound through the "resources" property.
- RESOURCE - Enum constant in enum class 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
- ResourceOperationInputOutputValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that resource properties are correctly used in resource-bound operations.
- ResourceOperationInputOutputValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ResourceOperationInputOutputValidator
- 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
. - RESPONSE_CODE - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- 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) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Returns a NeighborProvider that returns relationships that point at a given shape rather than relationships that the given shape points at.
- reverse(Model, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Returns a NeighborProvider that returns relationships that point at a given shape rather than relationships that the given shape points at.
- 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() - Method in interface software.amazon.smithy.model.selector.Selector
-
Deprecated.
- runner() - Static method in class software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
-
Creates a new Smithy test suite.
S
- scheme(String) - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Builder
- 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.
- scrubTraitDefinitions(Model, Predicate<Shape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Removes 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, Collection<Shape>) - Method in class software.amazon.smithy.model.selector.PathFinder
-
Finds all of the possible paths from the
startingShape
to any of the provided shapes intargetShapes
. - 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, SmithyPattern.Segment.Type) - Constructor for class software.amazon.smithy.model.pattern.SmithyPattern.Segment
- segments(List<SmithyPattern.Segment>) - Method in class software.amazon.smithy.model.pattern.SmithyPattern.Builder
- select(Model) - Method in interface software.amazon.smithy.model.selector.Selector
-
Matches a selector to a model.
- select(Selector) - Method in class software.amazon.smithy.model.validation.node.NodeValidatorPlugin.Context
-
Select and memoize shapes from the model using a Selector.
- selectMatches(BiConsumer<Shape, Map<String, Set<Shape>>>) - Method in class software.amazon.smithy.model.selector.Selector.Runner
-
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.Runner - Class in software.amazon.smithy.model.selector
-
Deprecated.This class is no longer necessary. It was originally intended to allow more customization to how selectors are executed against a model, but this has proven unnecessary.
- Selector.ShapeMatch - Class in software.amazon.smithy.model.selector
-
Represents a selector match found in the model.
- SelectorException - Exception in software.amazon.smithy.model.selector
-
Exception thrown when a selector evaluation is invalid.
- SelectorException(String) - Constructor for exception software.amazon.smithy.model.selector.SelectorException
- SelectorException(String, Throwable) - Constructor for exception software.amazon.smithy.model.selector.SelectorException
- SelectorSyntaxException - Exception in software.amazon.smithy.model.selector
-
Exception thrown when a selector expression is invalid.
- selectShapes() - Method in class software.amazon.smithy.model.selector.Selector.Runner
-
Deprecated.
- 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(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.SensitiveTrait
- SensitiveTrait.Provider - Class in software.amazon.smithy.model.traits
- serialize(Object) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Serializes the given
object
as aNode
. - serialize(Model) - Method in class software.amazon.smithy.model.shapes.ModelSerializer
- serialize(Model) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer
-
Serializes a
Model
into a set of Smithy IDL files. - serializePrelude() - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.Builder
-
Enables serializing shapes in the Smithy prelude.
- SERVER - Enum constant in enum class software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
-
A server, or any other kind of authoritative model consumer that does not honor the
InputTrait
andClientOptionalTrait
. - service(ServiceShape) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates a 'service'
AttributeValue
from a service shape. - service(ShapeId) - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
- SERVICE - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType.Category
- SERVICE - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- ServiceIndex - Class in software.amazon.smithy.model.knowledge
-
An index that resolves service protocols and auth schemes.
- ServiceIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.ServiceIndex
- 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 closures do not contain duplicate case-insensitive shape names.
- ServiceValidator() - Constructor for class software.amazon.smithy.model.validation.validators.ServiceValidator
- SET - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- SET_MEMBER - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Deprecated.
- setBindToTrait(ShapeId) - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
- setEventId(String) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
-
Changes the event ID emitted for events created by this validator.
- setEventShapeId(ShapeId) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
-
Changes the shape ID that emitted events are associated with.
- setMembersFromEnumTrait(EnumTrait) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Sets enum members from an
EnumTrait
. - setMembersFromEnumTrait(EnumTrait, boolean) - Method in class software.amazon.smithy.model.shapes.EnumShape.Builder
-
Sets enum members from an
EnumTrait
. - setMessageTemplate(String) - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
-
Sets the optional message template for each emitted event.
- 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. - setNodeCache(Node) - Method in class software.amazon.smithy.model.traits.AbstractTrait
-
Sets the node cache of the trait up front, if known.
- setOmitEmptyValues(boolean) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Gets whether or not false, empty arrays, and empty objects are omitted from serialized POJOs.
- setSelector(Selector) - Method in class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
- setSelector(Selector) - Method in class software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator.Config
- setSerializeNullValues(boolean) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Specifies if
null
values returned from getters are serialized. - setShape(SetShape) - Method in interface software.amazon.smithy.model.shapes.ShapeVisitor
-
Deprecated.
- SetShape - Class in software.amazon.smithy.model.shapes
-
Deprecated.
- SetShape.Builder - Class in software.amazon.smithy.model.shapes
-
Deprecated.Builder used to create a
SetShape
. - setStartingContext(String) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
-
Changes the starting context of the messages emitted by events.
- SetValidator - Class in software.amazon.smithy.model.validation.validators
- SetValidator() - Constructor for class software.amazon.smithy.model.validation.validators.SetValidator
- setValue(Node) - Method in class software.amazon.smithy.model.validation.NodeValidationVisitor
-
Changes the Node value the visitor will evaluate.
- setWhenMissingSetter(NodeMapper.WhenMissing) - Method in class software.amazon.smithy.model.node.NodeMapper
-
Sets the behavior of the deserializer when a setting is missing.
- severity(Severity) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets the required severity of the event.
- Severity - Enum Class 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(Shape, Map<String, Set<Shape>>) - Static method in interface software.amazon.smithy.model.selector.AttributeValue
-
Creates a 'shape'
AttributeValue
for the given shape. - Shape - Class in software.amazon.smithy.model.shapes
-
A
Shape
defines a model component. - SHAPE - Enum constant in enum class software.amazon.smithy.model.knowledge.TextInstance.TextLocationType
- shapeFilter(Predicate<Shape>) - Method in class software.amazon.smithy.model.shapes.ModelSerializer.Builder
-
Predicate that determines if a shape and its traits are serialized.
- shapeFilter(Predicate<Shape>) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.Builder
-
Predicate that determines if a shape and its traits are serialized.
- shapeId(ShapeId) - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample.Builder
- 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
- ShapeMatch(Shape, Map<String, Set<Shape>>) - Constructor for class software.amazon.smithy.model.selector.Selector.ShapeMatch
- shapePlacer(Function<Shape, Path>) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.Builder
-
Function that determines what output file a shape should go in.
- 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(Class<T>) - Method in class software.amazon.smithy.model.Model
-
Gets a stream of shapes in the index of a specific type
T
. - shapes(Model) - Method in interface software.amazon.smithy.model.selector.Selector
-
Returns a stream of shapes in a model that match the selector.
- 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 Class in software.amazon.smithy.model.shapes
-
An enumeration of the different types in a model.
- ShapeType.Category - Enum Class in software.amazon.smithy.model.shapes
- ShapeVisitor<R> - Interface in software.amazon.smithy.model.shapes
-
Shape visitor pattern.
- ShapeVisitor.Default<R> - Class in software.amazon.smithy.model.shapes
-
Creates
ShapeVisitor
that return a value when necessary when visiting shapes. - SHORT - Enum constant in enum class 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
. - SIMPLE - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType.Category
- 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
- SmithyIdlModelSerializer - Class in software.amazon.smithy.model.shapes
-
Serializes a
Model
into a set of Smithy IDL files. - SmithyIdlModelSerializer.Builder - Class in software.amazon.smithy.model.shapes
-
Builder used to create
SmithyIdlModelSerializer
. - SmithyPattern - Class in software.amazon.smithy.model.pattern
-
Represents a contained pattern.
- SmithyPattern(SmithyPattern.Builder) - Constructor for class software.amazon.smithy.model.pattern.SmithyPattern
- SmithyPattern.Builder - Class in software.amazon.smithy.model.pattern
-
Builder used to create a SmithyPattern.
- SmithyPattern.Segment - Class in software.amazon.smithy.model.pattern
-
Segment within a SmithyPattern.
- SmithyPattern.Segment.Type - Enum Class in software.amazon.smithy.model.pattern
- 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.node.internal - package software.amazon.smithy.model.node.internal
-
This is an adaptation of minimal-json: https://github.com/ralfstx/minimal-json
- 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.traits.synthetic - package software.amazon.smithy.model.traits.synthetic
- 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.linters - package software.amazon.smithy.model.validation.linters
- software.amazon.smithy.model.validation.node - package software.amazon.smithy.model.validation.node
- software.amazon.smithy.model.validation.suppressions - package software.amazon.smithy.model.validation.suppressions
- 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
-
Smithy validators.
- sortMembers(Model, Comparator<MemberShape>) - Method in class software.amazon.smithy.model.transform.ModelTransformer
-
Reorders the members of structure and union shapes using the given
Comparator
. - source(String, int, int) - Method in class software.amazon.smithy.model.shapes.AbstractShapeBuilder
-
Sets the source location of the shape.
- source(String, int, int) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- source(SourceLocation) - 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.SetShape.Builder
-
Deprecated.
- 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.ArrayNode.Builder
- sourceLocation(SourceLocation) - Method in class software.amazon.smithy.model.node.ObjectNode.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
- SparseTrait - Class in software.amazon.smithy.model.traits
-
Indicates that a list or map is sparse, meaning they may contain nulls.
- SparseTrait() - Constructor for class software.amazon.smithy.model.traits.SparseTrait
- SparseTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.SparseTrait
- SparseTrait.Provider - Class in software.amazon.smithy.model.traits
- 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 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() - Constructor for class software.amazon.smithy.model.traits.StreamingTrait
- StreamingTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.StreamingTrait
- StreamingTrait.Provider - Class in software.amazon.smithy.model.traits
- StreamingTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates the streaming trait.
- StreamingTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.StreamingTraitValidator
- STRING - Enum constant in enum class software.amazon.smithy.model.node.NodeType
- STRING - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- 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.
- stringRepresentations() - Static method in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
- 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.
- stringValue(String) - Method in class software.amazon.smithy.model.traits.EnumValueTrait.Builder
- structurallyExclusive(TraitDefinition.StructurallyExclusive) - Method in class software.amazon.smithy.model.traits.TraitDefinition.Builder
- STRUCTURE - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- STRUCTURE_MEMBER - Enum constant in enum class 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
. - SUPPRESSED - Enum constant in enum class software.amazon.smithy.model.validation.Severity
- Suppression - Interface in software.amazon.smithy.model.validation.suppressions
-
Suppresses
ValidationEvent
s emitted fromValidator
s. - suppressionReason(String) - Method in class software.amazon.smithy.model.validation.ValidationEvent.Builder
-
Sets a reason for suppressing the event.
- SuppressTrait - Class in software.amazon.smithy.model.traits
- SuppressTrait.Builder - Class in software.amazon.smithy.model.traits
- SuppressTrait.Provider - Class in software.amazon.smithy.model.traits
- SYNTHESIZE_ENUM_NAMES - Enum constant in enum class software.amazon.smithy.model.transform.ChangeShapeTypeOption
-
Enables synthesizing enum names when changing a string shape to an enum shape and the string shape's
EnumTrait
doesn't have names. - SyntheticEnumTrait - Class in software.amazon.smithy.model.traits.synthetic
- SyntheticEnumTrait.Builder - Class in software.amazon.smithy.model.traits.synthetic
T
- tags(Collection<String>) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- 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.
- TARGET - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
-
Only a single structure member can target a shape marked with the trait.
- 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
- test(ValidationEvent) - Method in interface software.amazon.smithy.model.validation.suppressions.Suppression
-
Determines if the suppression applies to the given event.
- 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. - TextIndex - Class in software.amazon.smithy.model.knowledge
-
Index containing the full set of
TextInstance
s associated with a model. - TextIndex(Model) - Constructor for class software.amazon.smithy.model.knowledge.TextIndex
- TextInstance - Class in software.amazon.smithy.model.knowledge
-
Contains information about text that occurs in the Smithy IDL written by the owner, inluding location metadata.
- TextInstance.TextLocationType - Enum Class in software.amazon.smithy.model.knowledge
-
Enum type indicating what kind of location in the model associated text appeared in.
- 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 - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- 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 Class 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 Class 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.ArrayNode
- 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.EnumShape
- 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.IntEnumShape
- 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
-
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.AuthDefinitionTrait
- 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.EnumDefinition
- toBuilder() - Method in class software.amazon.smithy.model.traits.EnumTrait
-
Deprecated.
- toBuilder() - Method in class software.amazon.smithy.model.traits.EnumValueTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- 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.ExternalDocumentationTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait
- 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.MixinTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.PaginatedTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.PropertyTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.RangeTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.RecommendedTrait
- 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.SuppressTrait
- toBuilder() - Method in class software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait
- 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.ValidationEvent
- toMessageString() - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Returns a string representation of the value that can be used for creating formatted messages.
- 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.AnnotationTrait
- toNode() - Method in class software.amazon.smithy.model.traits.EnumDefinition
- toNode() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
- toNode() - Method in class software.amazon.smithy.model.traits.ExamplesTrait.Example
- toNode() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- toNode() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- toNode() - Method in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
- toNode() - Method in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
- toNode() - Method in enum class software.amazon.smithy.model.validation.Severity
- 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
- TopologicalShapeSort - Class in software.amazon.smithy.model.loader
-
Topologically sorts shapes based on their dependencies (i.e., mixins).
- TopologicalShapeSort() - Constructor for class software.amazon.smithy.model.loader.TopologicalShapeSort
- TopologicalShapeSort.CycleException - Exception in software.amazon.smithy.model.loader
-
Thrown when cycles exist between shapes.
- toSet() - Method in class software.amazon.smithy.model.Model
-
Converts the model to an immutable Set of shapes.
- toSet(Class<T>) - Method in class software.amazon.smithy.model.Model
-
Gets an immutable Set of shapes of a specific type.
- toShapeId() - Method in exception software.amazon.smithy.model.loader.ModelSyntaxException
- 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 class software.amazon.smithy.model.traits.AnnotationTrait
- 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 class software.amazon.smithy.model.node.NodePointer
- toString() - Method in enum class 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.SmithyPattern.Segment
-
Get the segment as a literal value to be used in a pattern.
- toString() - Method in class software.amazon.smithy.model.pattern.SmithyPattern
- toString() - Method in interface software.amazon.smithy.model.selector.AttributeValue
-
Returns the string version of an attribute value.
- 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 class 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 enum class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Location
- toString() - Method in class software.amazon.smithy.model.traits.ReferencesTrait.Reference
- toString() - Method in enum class software.amazon.smithy.model.traits.TimestampFormatTrait.Format
- toString() - Method in class software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
- toString() - Method in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
- toString() - Method in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
- 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.
- TRAIT - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a shape and traits bound to the shape.
- TraitBreakingChangesValidator - Class in software.amazon.smithy.model.validation.validators
-
Validates that the JSON pointer paths of the breakingChanges property of a trait refers to valid parts of the model.
- TraitBreakingChangesValidator() - Constructor for class software.amazon.smithy.model.validation.validators.TraitBreakingChangesValidator
- 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.BreakingChangeRule - Class in software.amazon.smithy.model.traits
-
Represents an individual trait diff rule to define backward compatibility rules.
- TraitDefinition.Builder - Class in software.amazon.smithy.model.traits
-
Builder to create a TraitDefinition.
- TraitDefinition.ChangeType - Enum Class in software.amazon.smithy.model.traits
- TraitDefinition.Provider - Class in software.amazon.smithy.model.traits
- TraitDefinition.StructurallyExclusive - Enum Class in software.amazon.smithy.model.traits
-
The structural exclusion semantics of the trait.
- 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.
- traitFilter(Predicate<Trait>) - Method in class software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.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.
- traits(Collection<Trait>) - Method in class software.amazon.smithy.model.shapes.SetShape.Builder
-
Deprecated.
- traits(List<ShapeId>) - Method in class software.amazon.smithy.model.traits.AuthDefinitionTrait.Builder
- traits(List<ShapeId>) - Method in class software.amazon.smithy.model.traits.ProtocolDefinitionTrait.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 - Enum constant in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
- unescape(String) - Static method in class software.amazon.smithy.model.node.NodePointer
-
Unescapes special JSON pointer cases.
- UNION - Enum constant in enum class software.amazon.smithy.model.shapes.ShapeType
- UNION_MEMBER - Enum constant in enum class 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
. - UnionValidator - Class in software.amazon.smithy.model.validation.validators
- UnionValidator() - Constructor for class software.amazon.smithy.model.validation.validators.UnionValidator
- 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
- UNIT - Static variable in class software.amazon.smithy.model.traits.UnitTypeTrait
-
The shape ID of the built-in Unit type that uses this trait.
- UnitTypeTrait - Class in software.amazon.smithy.model.traits
- UnitTypeTrait() - Constructor for class software.amazon.smithy.model.traits.UnitTypeTrait
- UnitTypeTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.UnitTypeTrait
- UnitTypeTrait.Provider - Class in software.amazon.smithy.model.traits
- UnitTypeValidator - Class in software.amazon.smithy.model.validation.validators
-
Ensures that a unit type can only be referenced as operation input/output or by a tagged union member.
- UnitTypeValidator() - Constructor for class software.amazon.smithy.model.validation.validators.UnitTypeValidator
- UNKNOWN - Enum constant in enum class 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
- UnreferencedShapeValidator - Class in software.amazon.smithy.model.validation.validators
-
Adds a validation note event for each shape in the model that is not connected to a service shape.
- UnreferencedShapeValidator() - Constructor for class software.amazon.smithy.model.validation.validators.UnreferencedShapeValidator
- 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
- UnstableTrait - Class in software.amazon.smithy.model.traits
-
Marks a shape as unstable.
- UnstableTrait() - Constructor for class software.amazon.smithy.model.traits.UnstableTrait
- UnstableTrait(ObjectNode) - Constructor for class software.amazon.smithy.model.traits.UnstableTrait
- UnstableTrait.Provider - Class in software.amazon.smithy.model.traits
- UnstableTraitValidator - Class in software.amazon.smithy.model.validation.validators
-
Emits a validation event if a model contains shapes that are bound to unstable traits.
- UnstableTraitValidator() - Constructor for class software.amazon.smithy.model.validation.validators.UnstableTraitValidator
- 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 - Enum constant in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Relationships that exist between a resource and the update lifecycle operation.
- UPDATE - Enum constant in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Emit when a trait already existed, continues to exist, but it is modified.
- 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.
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 class software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator
- 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.AuthTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.DefaultTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.DefaultValueInUpdateValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.DeprecatedTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.EnumShapeValidator
- 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.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.HttpApiKeyAuthTraitValidator
- 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.HttpQueryParamsTraitValidator
- 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.HttpUriFormatValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.JsonNameValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.LengthTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.MediaTypeValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.MixinValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.NoInlineDocumentSupportValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.OperationValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.PaginatedTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.PatternTraitValidator
- 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.ResourceOperationInputOutputValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.ServiceValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.SetValidator
- 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.StreamingTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TargetValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.TraitBreakingChangesValidator
- 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.UnionValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.UnitTypeValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.UnreferencedShapeValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.UnstableTraitValidator
- validate(Model) - Method in class software.amazon.smithy.model.validation.validators.XmlNamespaceTraitValidator
- VALIDATE_PRELUDE - Static variable in class software.amazon.smithy.model.validation.validators.TraitValueValidator
- 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
-
Deprecated.
- ValidatedResult(T, List<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
- validateMemberShapeIds() - Method in class software.amazon.smithy.model.shapes.Shape
- validateMixins(Map<ShapeId, Shape>, Map<ShapeId, Trait>) - Method in class software.amazon.smithy.model.shapes.MemberShape
- validateMixins(Map<ShapeId, Shape>, Map<ShapeId, Trait>) - Method in class software.amazon.smithy.model.shapes.Shape
- 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. - validationEventListener(Consumer<ValidationEvent>) - Method in class software.amazon.smithy.model.loader.ModelAssembler
-
Sets a listener that is invoked each time a ValidationEvent is encountered while loading and validating the model.
- 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(String) - Method in class software.amazon.smithy.model.traits.EnumDefinition.Builder
- 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 class software.amazon.smithy.model.knowledge.HttpBinding.Location
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.knowledge.TextInstance.TextLocationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.neighbor.RelationshipDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.node.NodeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.pattern.SmithyPattern.Segment.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.shapes.ShapeType.Category
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Location
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.traits.TimestampFormatTrait.Format
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.transform.ChangeShapeTypeOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class software.amazon.smithy.model.validation.Severity
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class software.amazon.smithy.model.knowledge.HttpBinding.Location
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.knowledge.IdentifierBindingIndex.BindingType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.knowledge.TextInstance.TextLocationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.neighbor.RelationshipDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.neighbor.RelationshipType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.node.Node.NonNumericFloat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.node.NodeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.pattern.SmithyPattern.Segment.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.shapes.ShapeType.Category
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.shapes.ShapeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.traits.HttpApiKeyAuthTrait.Location
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.traits.TimestampFormatTrait.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.ChangeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.traits.TraitDefinition.StructurallyExclusive
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.transform.ChangeShapeTypeOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.validation.node.TimestampValidationStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class software.amazon.smithy.model.validation.Severity
-
Returns an array containing the constants of this enum class, 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
W
- Walker - Class in software.amazon.smithy.model.neighbor
-
Walks connected shapes within a Model.
- Walker(Model) - Constructor for class software.amazon.smithy.model.neighbor.Walker
- Walker(NeighborProvider) - Constructor for class software.amazon.smithy.model.neighbor.Walker
- walkShapeIds(Shape) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the model, returning their IDs in a set.
- walkShapeIds(Shape, Predicate<Relationship>) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the model (including the given shape), and returns a set of shape IDs.
- walkShapes(Shape) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the model, returning them in a set.
- walkShapes(Shape, Predicate<Relationship>) - Method in class software.amazon.smithy.model.neighbor.Walker
-
Walks connected shapes in the model (including the given shape), and returns them in a set.
- WARN - Enum constant in enum class software.amazon.smithy.model.node.NodeMapper.WhenMissing
-
Warns when attempting to deserialize an unknown property.
- 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 - Enum constant in enum class software.amazon.smithy.model.validation.Severity
- 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.
- withNamespace(String) - Method in class software.amazon.smithy.model.shapes.ShapeId
-
Creates a shape ID that uses a different namespace than the current ID.
- 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.
- withoutValue(Object) - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
- withTraitRelationships(Model, NeighborProvider) - Static method in interface software.amazon.smithy.model.neighbor.NeighborProvider
-
Creates a NeighborProvider that includes
RelationshipType.TRAIT
relationships. - withValue(boolean) - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
- withValue(Number) - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
- withValue(String) - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
- 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
. - withValue(T) - Method in class software.amazon.smithy.model.node.ArrayNode.Builder
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(ObjectNode) - 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(ObjectNode) - 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 and Interfaces|All Packages|Constant Field Values|Serialized Form
id(String eventId)
setter to match the node format.