Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addAllFiles(FileManifest) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds the files from another FileManifest into this FileManifest.
- addEvent(ValidationEvent) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Adds validation events to the result.
- addFile(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a path to the manifest.
- addFile(Path) - Method in class software.amazon.smithy.build.MockManifest
- addPluginManifest(String, FileManifest) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Adds an artifact result for a plugin.
- addProjectionResult(ProjectionResult) - Method in class software.amazon.smithy.build.SmithyBuildResult.Builder
-
Adds a projection result to the builder.
- allArtifacts() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the artifacts written during the build.
- allManifests() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the manifests that were used in the build.
- anyBroken() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Returns true if any projected models contain error or danger events.
- apply(Node) - Method in class software.amazon.smithy.build.JsonSubstitutions
-
Replaces strings in the given node.
- Apply - Class in software.amazon.smithy.build.transforms
-
Applies transforms of other projections.
- Apply() - Constructor for class software.amazon.smithy.build.transforms.Apply
- Apply.Config - Class in software.amazon.smithy.build.transforms
-
apply
configuration. - args(Node) - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
-
Sets the args of the transform.
- artifactName(String) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Set a custom artifact name used to change the output directory of a plugin.
B
- build() - Method in class software.amazon.smithy.build.model.MavenConfig.Builder
- build() - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
- build() - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Builds the projection.
- build() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
- build() - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
- build() - Method in class software.amazon.smithy.build.PluginContext.Builder
- build() - Method in class software.amazon.smithy.build.ProjectionResult.Builder
- build() - Method in class software.amazon.smithy.build.SmithyBuild
-
Builds the model and applies all projections.
- build() - Method in class software.amazon.smithy.build.SmithyBuildResult.Builder
- build() - Method in class software.amazon.smithy.build.TransformContext.Builder
- build(Consumer<ProjectionResult>, BiConsumer<String, Throwable>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Builds the model and applies all projections, passing each
ProjectionResult
to the provided callback as they are completed and each encountered exception to the providedexceptionCallback
as they are encountered. - BUILD_INFO_PATH - Static variable in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- builder() - Static method in class software.amazon.smithy.build.model.MavenConfig
- builder() - Static method in class software.amazon.smithy.build.model.MavenRepository
- builder() - Static method in class software.amazon.smithy.build.model.ProjectionConfig
- builder() - Static method in class software.amazon.smithy.build.model.SmithyBuildConfig
- builder() - Static method in class software.amazon.smithy.build.model.TransformConfig
- builder() - Static method in class software.amazon.smithy.build.PluginContext
-
Creates a new PluginContext Builder.
- builder() - Static method in class software.amazon.smithy.build.ProjectionResult
-
Creates a
ProjectionResult
builder. - builder() - Static method in class software.amazon.smithy.build.SmithyBuildResult
-
Creates a builder used to build SmithyBuildResult.
- builder() - Static method in class software.amazon.smithy.build.TransformContext
- Builder() - Constructor for class software.amazon.smithy.build.ProjectionResult.Builder
- BuildInfo - Class in software.amazon.smithy.build.plugins
-
POJO to represents a smithy-build-info.json file.
- BuildInfo() - Constructor for class software.amazon.smithy.build.plugins.BuildInfo
- BuildInfoPlugin - Class in software.amazon.smithy.build.plugins
-
Writes a build info file for each projection.
- BuildInfoPlugin() - Constructor for class software.amazon.smithy.build.plugins.BuildInfoPlugin
C
- ChangeStringEnumsToEnumShapes - Class in software.amazon.smithy.build.transforms
-
changeStringEnumsToEnumShapes
is used to change string shapes bearing the enum trait into enum shapes. - ChangeStringEnumsToEnumShapes() - Constructor for class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes
- ChangeStringEnumsToEnumShapes.Config - Class in software.amazon.smithy.build.transforms
-
changeStringEnumsToEnumShapes
configuration settings. - ChangeTypes - Class in software.amazon.smithy.build.transforms
-
changeType
is used to change the type of one or more shapes. - ChangeTypes() - Constructor for class software.amazon.smithy.build.transforms.ChangeTypes
- ChangeTypes.Config - Class in software.amazon.smithy.build.transforms
-
flattenNamespaces
configuration settings. - command() - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- command(List<String>) - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- config(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets the required configuration object used to build the model.
- config(SmithyBuildConfig) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets the required configuration object used to build the model.
- Config() - Constructor for class software.amazon.smithy.build.transforms.Apply.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ChangeTypes.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeMetadata.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesBySelector.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesByTag.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesByTrait.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTags.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraits.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraitsByTag.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.FilterSuppressions.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeMetadata.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeNamespaces.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeServices.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeShapesBySelector.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeShapesByTag.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeTags.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraits.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraitsByTag.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.RemoveTraitDefinitions.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.RemoveUnusedShapes.Config
- Config() - Constructor for class software.amazon.smithy.build.transforms.RenameShapes.Config
- ConfigurableProjectionTransformer<T> - Class in software.amazon.smithy.build.transforms
-
An abstract class used to more easily implement a Smithy build projection transformer that expects configuration input in a specific type,
T
. - ConfigurableProjectionTransformer() - Constructor for class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
- ConfigurableSmithyBuildPlugin<T> - Class in software.amazon.smithy.build.plugins
-
An abstract class used to more easily implement a Smithy build plugin that expects configuration input in a specific type,
T
. - ConfigurableSmithyBuildPlugin() - Constructor for class software.amazon.smithy.build.plugins.ConfigurableSmithyBuildPlugin
- create(ClassLoader) - Static method in class software.amazon.smithy.build.SmithyBuild
-
Creates a
SmithyBuild
implementation that is configured to discover various Smithy service providers using the givenClassLoader
. - create(ClassLoader, Supplier<ModelAssembler>) - Static method in class software.amazon.smithy.build.SmithyBuild
-
Creates a
SmithyBuild
implementation that is configured to discover various Smithy service providers using the givenClassLoader
. - create(Path) - Static method in interface software.amazon.smithy.build.FileManifest
-
Create a default file manifest for the given base path.
- create(Map<String, Node>) - Static method in class software.amazon.smithy.build.JsonSubstitutions
-
Creates a substitutions instance from a Map.
- create(ObjectNode) - Static method in class software.amazon.smithy.build.JsonSubstitutions
-
Creates a substitutions instance from an ObjectNode.
- createPluginNode(A, String) - Method in class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
-
Maps annotation data to a plugin configuration node.
- createServiceFactory() - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using SPI and the current thread's context class loader. - createServiceFactory() - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a SmithyBuildPlugin factory function using SPI and the current Thread's context class loader.
- createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using SPI. - createServiceFactory(ClassLoader) - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a SmithyBuildPlugin factory function using SPI.
- createServiceFactory(Iterable<ProjectionTransformer>) - Static method in interface software.amazon.smithy.build.ProjectionTransformer
-
Creates a
ProjectionTransformer
factory function using the given transformers. - createServiceFactory(Iterable<SmithyBuildPlugin>) - Static method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Creates a factory function used that creates SmithyBuildPlugins using a list of resolved plugins.
D
- dependencies(Collection<String>) - Method in class software.amazon.smithy.build.model.MavenConfig.Builder
E
- env() - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- env(Map<String, String>) - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- equals(Object) - Method in class software.amazon.smithy.build.model.MavenConfig
- equals(Object) - Method in class software.amazon.smithy.build.model.MavenRepository
- equals(Object) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- events(List<ValidationEvent>) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the validation events that occurred after projecting the model.
- events(List<ValidationEvent>) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the validation events of the projection.
- ExcludeMetadata - Class in software.amazon.smithy.build.transforms
-
excludeMetadata
removes metadata entries when a metadata key matcheskeys
. - ExcludeMetadata() - Constructor for class software.amazon.smithy.build.transforms.ExcludeMetadata
- ExcludeMetadata.Config - Class in software.amazon.smithy.build.transforms
-
excludeMetadata
configuration settings. - ExcludeShapesBySelector - Class in software.amazon.smithy.build.transforms
-
excludeShapesBySelector
excludes the shapes matching the given selector. - ExcludeShapesBySelector() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesBySelector
- ExcludeShapesBySelector.Config - Class in software.amazon.smithy.build.transforms
-
excludeShapesBySelector
configuration. - ExcludeShapesByTag - Class in software.amazon.smithy.build.transforms
-
excludeShapesByTag
removes shapes if they are tagged with one or more of the given arguments. - ExcludeShapesByTag() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- ExcludeShapesByTag.Config - Class in software.amazon.smithy.build.transforms
-
excludeShapesByTag
configuration. - ExcludeShapesByTrait - Class in software.amazon.smithy.build.transforms
-
Removes shapes from the model if they are marked with a specific trait.
- ExcludeShapesByTrait() - Constructor for class software.amazon.smithy.build.transforms.ExcludeShapesByTrait
- ExcludeShapesByTrait.Config - Class in software.amazon.smithy.build.transforms
- ExcludeTags - Class in software.amazon.smithy.build.transforms
-
excludeTags
removes tags from shapes and trait definitions that match any of the providedtags
. - ExcludeTags() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTags
- ExcludeTags.Config - Class in software.amazon.smithy.build.transforms
-
excludeTags
configuration. - ExcludeTraits - Class in software.amazon.smithy.build.transforms
-
excludeTraits
removes trait definitions and traits from shapes when a trait name matches any of the values given intraits
. - ExcludeTraits() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraits
- ExcludeTraits.Config - Class in software.amazon.smithy.build.transforms
-
excludeTraits
configuration settings. - ExcludeTraitsByTag - Class in software.amazon.smithy.build.transforms
-
excludeTraitsByTag
removes traits and trait definitions from a model if the trait definition contains any of the providedtags
. - ExcludeTraitsByTag() - Constructor for class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- ExcludeTraitsByTag.Config - Class in software.amazon.smithy.build.transforms
-
excludeTraitsByTag
configuration settings. - execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.ConfigurableSmithyBuildPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.ModelPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.NullabilityReportPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.RunPlugin
- execute(PluginContext) - Method in class software.amazon.smithy.build.plugins.SourcesPlugin
- execute(PluginContext) - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Executes the plugin, creating any number of artifacts.
- executeWithConfig(PluginContext, T) - Method in class software.amazon.smithy.build.plugins.ConfigurableSmithyBuildPlugin
-
Executes the plugin using the deserialized configuration object.
- expectFileBytes(String) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns the bytes.
- expectFileBytes(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns the bytes.
- expectFileString(String) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns a UTF-8 string.
- expectFileString(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Expects that the given file was stored and returns a UTF-8 string.
F
- fileManifest(FileManifest) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the required
FileManifest
to use in the plugin. - FileManifest - Interface in software.amazon.smithy.build
-
Creates and tracks the files generated by a
SmithyBuildPlugin
. - fileManifestFactory(Function<Path, FileManifest>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function that's used to create
FileManifest
objects when writingSmithyBuildPlugin
artifacts. - FilterSuppressions - Class in software.amazon.smithy.build.transforms
-
Filters suppressions found in metadata and
SuppressTrait
traits. - FilterSuppressions() - Constructor for class software.amazon.smithy.build.transforms.FilterSuppressions
- FilterSuppressions.Config - Class in software.amazon.smithy.build.transforms
-
filterSuppressions
configuration settings. - FlattenNamespaces - Class in software.amazon.smithy.build.transforms
-
flattenNamespaces
updates a model by flattening the namespaces of shapes connected to a service into a single, target namespace. - FlattenNamespaces() - Constructor for class software.amazon.smithy.build.transforms.FlattenNamespaces
- FlattenNamespaces.Config - Class in software.amazon.smithy.build.transforms
-
flattenNamespaces
configuration settings. - fromNode(Node) - Static method in class software.amazon.smithy.build.model.MavenConfig
- fromNode(Node) - Static method in class software.amazon.smithy.build.model.MavenRepository
- fromNode(Node) - Static method in class software.amazon.smithy.build.model.ProjectionConfig
- fromNode(Node) - Static method in class software.amazon.smithy.build.model.SmithyBuildConfig
- fromNode(Node) - Static method in class software.amazon.smithy.build.model.TransformConfig
G
- getAdditionalProjections(TransformContext) - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Allows the composition of projections by returning additional projections to run after the current one.
- getAdditionalProjections(TransformContext) - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- getAdditionalProjections(TransformContext) - Method in class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
- getAdditionalProjectionsFunction() - Method in class software.amazon.smithy.build.transforms.Apply
- getAdditionalProjectionsFunction() - Method in class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
- getAnnotationClass() - Method in class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
-
Annotation class for the processor.
- getArgs() - Method in class software.amazon.smithy.build.model.TransformConfig
- getArtifactName() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the plugin artifact name, if present.
- getBackwardCompatibleNameMapping() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- getBaseDir() - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the base directory of the manifest.
- getBaseDir() - Method in class software.amazon.smithy.build.MockManifest
- getConfigType() - Method in class software.amazon.smithy.build.plugins.ConfigurableSmithyBuildPlugin
-
Gets the configuration class type.
- getConfigType() - Method in class software.amazon.smithy.build.transforms.Apply
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ChangeTypes
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
-
Gets the configuration class type.
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesBySelector
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTrait
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeTags
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeTraits
- getConfigType() - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- getConfigType() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions
- getConfigType() - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeMetadata
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeServices
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeShapesBySelector
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeTags
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeTraits
- getConfigType() - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- getConfigType() - Method in class software.amazon.smithy.build.transforms.RemoveTraitDefinitions
- getConfigType() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- getConfigType() - Method in class software.amazon.smithy.build.transforms.RenameShapes
- getDefaultOutputDirectory() - Static method in class software.amazon.smithy.build.SmithyBuild
-
Gets the default directory where smithy-build artifacts are written.
- getDependencies() - Method in class software.amazon.smithy.build.model.MavenConfig
-
Gets the dependencies.
- getEventIdAllowList() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets a list of allowed event IDs.
- getEventIdDenyList() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets a list of denied event IDs.
- getEvents() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the validation events encountered after projecting the model.
- getEvents() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the validation events encountered after projecting the model.
- getExportTagged() - Method in class software.amazon.smithy.build.transforms.RemoveTraitDefinitions.Config
-
Gets the set of tags that are used to export trait definitions.
- getExportTagged() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes.Config
-
Gets the set of tags that are used to export shapes.
- getFileBytes(String) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the bytes of a stored file.
- getFileBytes(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the bytes of a stored file.
- getFileManifest() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the FileManifest used to create files in the projection.
- getFiles() - Method in interface software.amazon.smithy.build.FileManifest
-
Gets all of the files in the result.
- getFiles() - Method in class software.amazon.smithy.build.MockManifest
- getFilesIn(String) - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the paths to files stored under a prefix.
- getFilesIn(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Gets the paths to files stored under a prefix.
- getFileString(String) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the contents of a stored file as a String.
- getFileString(Path) - Method in class software.amazon.smithy.build.MockManifest
-
Gets the contents of a stored file as a String.
- getHttpCredentials() - Method in class software.amazon.smithy.build.model.MavenRepository
- getId() - Method in class software.amazon.smithy.build.model.MavenRepository
- getImports() - Method in class software.amazon.smithy.build.model.ProjectionConfig
-
Gets the imports configured for the projection.
- getImports() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the paths to all the models to import.
- getIncludeTagged() - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
-
Gets the set of tags that are retained in the model.
- getKeys() - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata.Config
- getKeys() - Method in class software.amazon.smithy.build.transforms.IncludeMetadata.Config
- getLastModifiedInMillis() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Get the last modified time of the configuration file.
- getMaven() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets Maven dependency configuration.
- getMetadata() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getModel() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the model that was projected.
- getModel() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the result of projecting the model.
- getModel() - Method in class software.amazon.smithy.build.TransformContext
-
Gets the model to transform.
- getModelWithoutTraitShapes() - Method in class software.amazon.smithy.build.PluginContext
-
Creates a new 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.build.model.TransformConfig
- getName() - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.ModelPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.NullabilityReportPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.RunPlugin
- getName() - Method in class software.amazon.smithy.build.plugins.SourcesPlugin
- getName() - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Gets the name of the transformer.
- getName() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Gets the name of the plugin.
- getName() - Method in class software.amazon.smithy.build.transforms.Apply
- getName() - Method in class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes
- getName() - Method in class software.amazon.smithy.build.transforms.ChangeTypes
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesBySelector
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTrait
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTags
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTraits
- getName() - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- getName() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions
- getName() - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeMetadata
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeServices
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeShapesBySelector
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTags
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTraits
- getName() - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- getName() - Method in class software.amazon.smithy.build.transforms.RemoveTraitDefinitions
- getName() - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- getName() - Method in class software.amazon.smithy.build.transforms.RenameShapes
- getNamespace() - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
-
Gets the target namespace that existing namespaces will be flattened into.
- getNamespaceAllowList() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets the metadata suppression namespace allow list.
- getNamespaceDenyList() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets the metadata suppression namespace deny list.
- getNamespaces() - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces.Config
- getOperationShapeIds() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getOriginalModel() - Method in class software.amazon.smithy.build.PluginContext
-
Get the original model before applying the projection.
- getOriginalModel() - Method in class software.amazon.smithy.build.TransformContext
-
Get the original model before applying the projection.
- getOriginalModelValidationEvents() - Method in class software.amazon.smithy.build.TransformContext
-
Gets an immutable list of
ValidationEvent
s that were encountered when loading the source model. - getOutputDirectory() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
- getPluginClassLoader() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the ClassLoader that should be used in build plugins to load services.
- getPluginManifest(String) - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the result of a specific plugin by plugin artifact name.
- getPluginManifests() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the results of each plugin.
- getPluginName() - Method in class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
-
Name of the Smithy build plugin to execute with this annotation processor.
- getPlugins() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- getPlugins() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the globally configured plugins that are applied to every projection.
- getProjection() - Method in class software.amazon.smithy.build.PluginContext
- getProjection() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getProjectionName() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the name of the projection being applied.
- getProjectionName() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getProjectionName() - Method in class software.amazon.smithy.build.ProjectionResult
-
Gets the name of the projection that was executed.
- getProjectionName() - Method in class software.amazon.smithy.build.TransformContext
-
Gets the name of the projection being applied.
- getProjectionResult(String) - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets a projection result by name.
- getProjectionResults() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the projection results as an unmodifiable list.
- getProjectionResultsMap() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets all of the projection results as a map of projection name to
ProjectionResult
. - getProjections() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets all the configured projections.
- getProjections() - Method in class software.amazon.smithy.build.transforms.Apply.Config
-
Gets the ordered list of projections to apply by name.
- getProxyCredentials() - Method in class software.amazon.smithy.build.model.MavenRepository
- getProxyHost() - Method in class software.amazon.smithy.build.model.MavenRepository
- getRemoveReasons() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets whether suppression reasons are removed.
- getRemoveUnused() - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Gets whether unused suppressions are removed.
- getRenamed() - Method in class software.amazon.smithy.build.transforms.RenameShapes.Config
-
Gets the map of shape ids to be renamed.
- getRepositories() - Method in class software.amazon.smithy.build.model.MavenConfig
-
Gets the repositories.
- getResourceShapeIds() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getSelector() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesBySelector.Config
-
Gets the selector used to filter the shapes.
- getSelector() - Method in class software.amazon.smithy.build.transforms.IncludeShapesBySelector.Config
-
Gets the selector used to filter the shapes.
- getService() - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
- getServices() - Method in class software.amazon.smithy.build.transforms.IncludeServices.Config
- getServiceShapeIds() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getSettings() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the plugin configuration settings.
- getSettings() - Method in class software.amazon.smithy.build.TransformContext
-
Gets the arguments object of the transform.
- getShapeTypes() - Method in class software.amazon.smithy.build.transforms.ChangeTypes.Config
- getSources() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the paths to all model sources.
- getSources() - Method in class software.amazon.smithy.build.PluginContext
-
Gets the source models, or models that are considered the subject of the build.
- getSources() - Method in class software.amazon.smithy.build.TransformContext
-
Gets the source models, or models that are considered the subject of the build.
- getSynthesizeEnumNames() - Method in class software.amazon.smithy.build.transforms.ChangeTypes.Config
- getSynthesizeNames() - Method in class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes.Config
- getTags() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag.Config
-
Gets the set of tags that causes shapes to be removed.
- getTags() - Method in class software.amazon.smithy.build.transforms.ExcludeTags.Config
-
Gets the set of tags that are removed from the model.
- getTags() - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag.Config
- getTags() - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag.Config
-
Gets the set of tags that cause shapes to be included.
- getTags() - Method in class software.amazon.smithy.build.transforms.IncludeTags.Config
-
Gets the set of tags that are retained in the model.
- getTags() - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag.Config
- getTraitDefNames() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getTraitNames() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getTraits() - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTrait.Config
-
Gets the shape IDs of the traits to filter shapes by.
- getTraits() - Method in class software.amazon.smithy.build.transforms.ExcludeTraits.Config
-
Gets the list of trait shape IDs/namespaces to exclude.
- getTraits() - Method in class software.amazon.smithy.build.transforms.IncludeTraits.Config
-
Gets the list of trait shape IDs to include.
- getTransformer() - Method in class software.amazon.smithy.build.TransformContext
-
Gets the
ModelTransformer
that has been configured to aid in the transformation. - getTransforms() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- getUrl() - Method in class software.amazon.smithy.build.model.MavenRepository
- getValidationEvents() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- getVersion() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Gets the version of Smithy-Build.
- getVersion() - Method in class software.amazon.smithy.build.plugins.BuildInfo
H
- hasFile(String) - Method in interface software.amazon.smithy.build.FileManifest
-
Checks if the given file is stored in the manifest.
- hasFile(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Checks if the given file is stored in the manifest.
- hashCode() - Method in class software.amazon.smithy.build.model.MavenConfig
- hashCode() - Method in class software.amazon.smithy.build.model.MavenRepository
- hashCode() - Method in class software.amazon.smithy.build.plugins.BuildInfo
- httpCredentials(String) - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
I
- id(String) - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
- ignoreMissingPlugins(boolean) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Logs instead of failing when a plugin can't be found by name.
- importBasePath(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Deprecated.
- imports(Collection<String>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Replaces the imports of the projection.
- imports(Collection<String>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Replaces imports on the config.
- IN_MEMORY - Enum constant in enum class software.amazon.smithy.build.MockManifest.StoreMode
-
Store all saved files in memory.
- IncludeMetadata - Class in software.amazon.smithy.build.transforms
-
includeMetadata
keeps only metadata keys specifically defined in the providedkeys
setting. - IncludeMetadata() - Constructor for class software.amazon.smithy.build.transforms.IncludeMetadata
- IncludeMetadata.Config - Class in software.amazon.smithy.build.transforms
-
includeMetadata
configuration settings. - IncludeNamespaces - Class in software.amazon.smithy.build.transforms
-
includeNamespaces
filters out shapes and trait definitions that are not part of one of the givennamespaces
. - IncludeNamespaces() - Constructor for class software.amazon.smithy.build.transforms.IncludeNamespaces
- IncludeNamespaces.Config - Class in software.amazon.smithy.build.transforms
-
includeNamespaces
configuration. - IncludeServices - Class in software.amazon.smithy.build.transforms
-
includeServices
filters out service shapes that are not included in the list of shape IDs contained in theservices
property. - IncludeServices() - Constructor for class software.amazon.smithy.build.transforms.IncludeServices
- IncludeServices.Config - Class in software.amazon.smithy.build.transforms
-
includeServices
configuration. - IncludeShapesBySelector - Class in software.amazon.smithy.build.transforms
-
includeShapesBySelector
includes the shapes matching the given selector. - IncludeShapesBySelector() - Constructor for class software.amazon.smithy.build.transforms.IncludeShapesBySelector
- IncludeShapesBySelector.Config - Class in software.amazon.smithy.build.transforms
-
includeShapesBySelector
configuration. - IncludeShapesByTag - Class in software.amazon.smithy.build.transforms
-
includeShapesByTag
removes shapes and trait definitions that are not tagged with at least one of the tags provided in thetags
argument. - IncludeShapesByTag() - Constructor for class software.amazon.smithy.build.transforms.IncludeShapesByTag
- IncludeShapesByTag.Config - Class in software.amazon.smithy.build.transforms
-
includeShapesByTag
configuration. - IncludeTags - Class in software.amazon.smithy.build.transforms
-
includeTags
removes tags from shapes and trait definitions that are not in the set of tags defined in thetags
property. - IncludeTags() - Constructor for class software.amazon.smithy.build.transforms.IncludeTags
- IncludeTags.Config - Class in software.amazon.smithy.build.transforms
-
includeTags
configuration. - IncludeTraits - Class in software.amazon.smithy.build.transforms
-
includeTraits
removes trait definitions when a trait name does not match one of the providedtraits
shape IDs. - IncludeTraits() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraits
- IncludeTraits.Config - Class in software.amazon.smithy.build.transforms
-
includeTraits
configuration settings. - IncludeTraitsByTag - Class in software.amazon.smithy.build.transforms
-
includeTraitsByTag
removes trait definitions from a model if the definition does not contain at least one of the providedtags
. - IncludeTraitsByTag() - Constructor for class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- IncludeTraitsByTag.Config - Class in software.amazon.smithy.build.transforms
-
includeTraitsByTag
configuration settings. - init(ProcessingEnvironment) - Method in class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
- isAbstract() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- isBroken() - Method in class software.amazon.smithy.build.ProjectionResult
-
Returns true if the projection contains error or danger events.
- isEmpty() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Checks if the results is empty.
- isIgnoreMissingPlugins() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
If a plugin can't be found, Smithy will by default fail the build.
- isSerial() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Plugins can choose whether or not projections they are in can be run in parallel with other projections.
- isSourceMetadata(String) - Method in class software.amazon.smithy.build.PluginContext
-
Checks if the given metadata key-value pair is either not present in the old model (thus a new, source metadata), or is present and the filename of the entry in the original model matches one of the defined
sources
. - isSourceShape(ToShapeId) - Method in class software.amazon.smithy.build.PluginContext
-
Checks if the given shape/ID is either not present in the original model (thus a new, source shape), or is present and the filename of the shape in the original model matches one of the defined
sources
.
J
- JsonSubstitutions - Class in software.amazon.smithy.build
-
Finds string set in a Node object string value and replaces them with a corresponding Node.
L
- lastModifiedInMillis(long) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
- load(Path) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Loads and merges the config file into the builder.
- load(Path) - Static method in class software.amazon.smithy.build.model.SmithyBuildConfig
-
Loads a SmithyBuildConfig from a JSON file on disk.
M
- maven(MavenConfig) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
- MavenConfig - Class in software.amazon.smithy.build.model
- MavenConfig.Builder - Class in software.amazon.smithy.build.model
- MavenRepository - Class in software.amazon.smithy.build.model
- MavenRepository(MavenRepository.Builder) - Constructor for class software.amazon.smithy.build.model.MavenRepository
- MavenRepository.Builder - Class in software.amazon.smithy.build.model
- merge(MavenConfig) - Method in class software.amazon.smithy.build.model.MavenConfig
- merge(SmithyBuildConfig) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Updates this configuration with the configuration of another file.
- MockManifest - Class in software.amazon.smithy.build
-
A
FileManifest
that doesn't actually store files on disk. - MockManifest() - Constructor for class software.amazon.smithy.build.MockManifest
-
Creates a mock manifest that stores files in memory and uses a base directory of "/".
- MockManifest(Path) - Constructor for class software.amazon.smithy.build.MockManifest
-
Creates a mock manifest that stores files in memory.
- MockManifest(Path, MockManifest.StoreMode) - Constructor for class software.amazon.smithy.build.MockManifest
- MockManifest.StoreMode - Enum Class in software.amazon.smithy.build
-
The way in which files are stored.
- model(Model) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the required model that is being built.
- model(Model) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the required model that was projected.
- model(Model) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets an optional model to use with the build.
- model(Model) - Method in class software.amazon.smithy.build.TransformContext.Builder
- modelAssemblerSupplier(Supplier<ModelAssembler>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Called to create
ModelAssembler
to load the original model and to load each projected model. - ModelPlugin - Class in software.amazon.smithy.build.plugins
-
Writes the projected/filtered SmithyBuild model.
- ModelPlugin() - Constructor for class software.amazon.smithy.build.plugins.ModelPlugin
- modelTransformer(ModelTransformer) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a custom
ModelTransformer
to use when building projections.
N
- name(String) - Method in class software.amazon.smithy.build.model.TransformConfig.Builder
-
Sets the required name.
- NullabilityReportPlugin - Class in software.amazon.smithy.build.plugins
-
Generates a JSON report that contains a mapping of every structure member to whether the member is considered nullable in v1 and v2 implementations.
- NullabilityReportPlugin() - Constructor for class software.amazon.smithy.build.plugins.NullabilityReportPlugin
O
- originalModel(Model) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the model that is being built before it was transformed in the projection.
- originalModel(Model) - Method in class software.amazon.smithy.build.TransformContext.Builder
- originalModelValidationEvents(List<ValidationEvent>) - Method in class software.amazon.smithy.build.TransformContext.Builder
- outputDirectory(String) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Set a directory where the build artifacts are written.
- outputDirectory(String) - Method in class software.amazon.smithy.build.SmithyBuild
-
Set a directory where the build artifacts are written.
- outputDirectory(Path) - Method in class software.amazon.smithy.build.SmithyBuild
-
Set a directory where the build artifacts are written.
P
- PATH_ONLY - Enum constant in enum class software.amazon.smithy.build.MockManifest.StoreMode
-
Store only the path of each saved file.
- pluginClassLoader(ClassLoader) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets a ClassLoader that should be used by build plugins when loading services.
- pluginClassLoader(ClassLoader) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a ClassLoader that should be used by SmithyBuild plugins when discovering services.
- PluginContext - Class in software.amazon.smithy.build
-
Context object used in plugin execution.
- PluginContext.Builder - Class in software.amazon.smithy.build
-
Builds a
PluginContext
. - pluginFactory(Function<String, Optional<SmithyBuildPlugin>>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function used to create plugins by name.
- pluginFilter(Predicate<String>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a predicate that accepts the name of a plugin and returns true if the plugin should be built.
- plugins(Map<String, ObjectNode>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Replaces the plugins of the projection.
- plugins(Map<String, ObjectNode>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Replaces plugins on the config.
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
- projection(String, ProjectionConfig) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the projection that the plugin belongs to.
- ProjectionConfig - Class in software.amazon.smithy.build.model
-
ProjectionConfig stored in a
SmithyBuildConfig
. - ProjectionConfig.Builder - Class in software.amazon.smithy.build.model
-
Builds a
ProjectionConfig
. - projectionFilter(Predicate<String>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a predicate that accepts the name of a projection and returns true if the projection should be built.
- projectionName(String) - Method in class software.amazon.smithy.build.ProjectionResult.Builder
-
Sets the required projection name.
- projectionName(String) - Method in class software.amazon.smithy.build.TransformContext.Builder
- ProjectionResult - Class in software.amazon.smithy.build
-
The result of applying a projection to a model.
- ProjectionResult.Builder - Class in software.amazon.smithy.build
-
Builds up a
ProjectionResult
. - projections(Map<String, ProjectionConfig>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Replaces projections on the config.
- ProjectionTransformer - Interface in software.amazon.smithy.build
-
Creates a model transformer by name.
- proxyCredentials(String) - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
- proxyHost(String) - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
R
- registerSources(Path...) - Method in class software.amazon.smithy.build.SmithyBuild
-
Registers the given paths as sources of the model being built.
- RemoveTraitDefinitions - Class in software.amazon.smithy.build.transforms
-
removeTraitShapes
removes all trait definitions from a model, but leaves if the trait definition contains any of the providedtags
. - RemoveTraitDefinitions() - Constructor for class software.amazon.smithy.build.transforms.RemoveTraitDefinitions
- RemoveTraitDefinitions.Config - Class in software.amazon.smithy.build.transforms
-
removeTraitShapes
configuration settings. - RemoveUnusedShapes - Class in software.amazon.smithy.build.transforms
-
removeUnusedShapes
removes shapes from the model that are not connected to any service shape. - RemoveUnusedShapes() - Constructor for class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- RemoveUnusedShapes.Config - Class in software.amazon.smithy.build.transforms
-
removeUnusedShapes
configuration settings. - RenameShapes - Class in software.amazon.smithy.build.transforms
-
renameShapes
updates a model by renaming shapes. - RenameShapes() - Constructor for class software.amazon.smithy.build.transforms.RenameShapes
- RenameShapes.Config - Class in software.amazon.smithy.build.transforms
-
renameShapes
configuration settings. - repositories(Collection<MavenRepository>) - Method in class software.amazon.smithy.build.model.MavenConfig.Builder
- requiresValidModel() - Method in class software.amazon.smithy.build.plugins.BuildInfoPlugin
- requiresValidModel() - Method in class software.amazon.smithy.build.plugins.NullabilityReportPlugin
- requiresValidModel() - Method in class software.amazon.smithy.build.plugins.RunPlugin
- requiresValidModel() - Method in interface software.amazon.smithy.build.SmithyBuildPlugin
-
Plugins can choose whether or not to create artifacts based on whether or not the projection encountered error or unsuppressed danger events.
- resolvePath(Path) - Method in interface software.amazon.smithy.build.FileManifest
-
Resolves a path against the base path of the manifest.
- RunPlugin - Class in software.amazon.smithy.build.plugins
-
Runs a process-based plugin.
- RunPlugin() - Constructor for class software.amazon.smithy.build.plugins.RunPlugin
- RunPlugin.Settings - Class in software.amazon.smithy.build.plugins
S
- sendPrelude() - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- sendPrelude(boolean) - Method in class software.amazon.smithy.build.plugins.RunPlugin.Settings
- setAbstract(boolean) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Sets the
abstract
property of the projection. - setEventIdAllowList(Set<String>) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Sets a list of event IDs that can be referred to in suppressions.
- setEventIdDenyList(Set<String>) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Sets a list of event IDs that cannot be referred to in suppressions.
- setExportTagged(Set<String>) - Method in class software.amazon.smithy.build.transforms.RemoveTraitDefinitions.Config
-
You can export trait definitions by applying specific tags to the trait definition and adding the list of export tags as an argument to the transformer.
- setExportTagged(Set<String>) - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes.Config
-
You can export shapes that are not connected to any service shape by applying specific tags to the shape and adding the list of export tags as an argument to the transformer.
- setIncludeTagged(Set<String>) - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
-
Sets the set of tags that are retained in the model.
- setKeys(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata.Config
-
Sets the list of keys to remove from metadata.
- setKeys(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeMetadata.Config
-
Sets the list of keys to keep in metadata.
- setMetadata(Map<String, Node>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setNamespace(String) - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
-
Sets the target namespace that existing namespaces will be flattened into.
- setNamespaceAllowList(Set<String>) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Sets a list of namespaces that can be referred to in metadata suppressions.
- setNamespaceDenyList(Set<String>) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Sets a list of namespaces that cannot be referred to in metadata suppressions.
- setNamespaces(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces.Config
-
Sets the list of namespaces to include.
- setOperationShapeIds(List<ShapeId>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setProjection(ProjectionConfig) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setProjectionName(String) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setProjections(List<String>) - Method in class software.amazon.smithy.build.transforms.Apply.Config
-
Sets the ordered list of projection names to apply.
- setRemoveReasons(boolean) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Set to true to remove the
reason
property from metadata suppressions. - setRemoveUnused(boolean) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions.Config
-
Set to true to remove suppressions that have no effect.
- setRenamed(Map<String, String>) - Method in class software.amazon.smithy.build.transforms.RenameShapes.Config
-
Sets the map of `from` shape ids to the `to` shape id values that they shapes will be renamed to.
- setResourceShapeIds(List<ShapeId>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setSelector(Selector) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesBySelector.Config
-
Sets the selector used to filter the shapes.
- setSelector(Selector) - Method in class software.amazon.smithy.build.transforms.IncludeShapesBySelector.Config
-
Sets the selector used to filter the shapes.
- setService(ShapeId) - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces.Config
-
Sets the service ShapeId that will be flattened into the target namespace.
- setServices(Set<ShapeId>) - Method in class software.amazon.smithy.build.transforms.IncludeServices.Config
-
Sets the list of service shapes IDs to include.
- setServiceShapeIds(List<ShapeId>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setShapeTypes(Map<ShapeId, ShapeType>) - Method in class software.amazon.smithy.build.transforms.ChangeTypes.Config
-
Sets the map of shape IDs to shape types to set.
- setSynthesizeEnumNames(boolean) - Method in class software.amazon.smithy.build.transforms.ChangeTypes.Config
-
Sets whether to synthesize names for enums that don't already have them.
- setSynthesizeNames(boolean) - Method in class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes.Config
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag.Config
-
Sets the set of tags that causes shapes to be removed.
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeTags.Config
-
Sets the set of tags that are removed from the model.
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag.Config
-
Sets the list of tags that, if present, cause the trait to be removed.
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag.Config
-
Sets the set of tags that cause shapes to be included.
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeTags.Config
-
Sets the set of tags that are retained in the model.
- setTags(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag.Config
-
Sets the list of tags that must be present for a trait to be included in the filtered model.
- settings(ObjectNode) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Sets the settings of the plugin.
- settings(ObjectNode) - Method in class software.amazon.smithy.build.TransformContext.Builder
- Settings() - Constructor for class software.amazon.smithy.build.plugins.RunPlugin.Settings
- setTraitDefNames(List<ShapeId>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setTraitNames(List<ShapeId>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setTraits(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTrait.Config
-
Sets the shape IDs of the traits to filter shapes by.
- setTraits(Set<String>) - Method in class software.amazon.smithy.build.transforms.ExcludeTraits.Config
-
Sets the list of trait shape IDs/namespaces to exclude.
- setTraits(Set<String>) - Method in class software.amazon.smithy.build.transforms.IncludeTraits.Config
-
Sets the list of trait shape IDs to include.
- setValidationEvents(List<ValidationEvent>) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- setVersion(String) - Method in class software.amazon.smithy.build.plugins.BuildInfo
- size() - Method in class software.amazon.smithy.build.SmithyBuildResult
-
Gets the number of projection results in the map.
- SmithyAnnotationProcessor<A extends Annotation> - Class in software.amazon.smithy.build.processor
-
Base implementation of a Smithy annotation processor.
- SmithyAnnotationProcessor() - Constructor for class software.amazon.smithy.build.processor.SmithyAnnotationProcessor
- SmithyBuild - Class in software.amazon.smithy.build
-
Runs the projections and plugins found in a
SmithyBuildConfig
and writes the artifacts to aFileManifest
. - SmithyBuild() - Constructor for class software.amazon.smithy.build.SmithyBuild
- SmithyBuild(SmithyBuildConfig) - Constructor for class software.amazon.smithy.build.SmithyBuild
- SmithyBuildConfig - Class in software.amazon.smithy.build.model
-
Filter configuration that contains a list of named projections that are used to apply filters to a model.
- SmithyBuildConfig.Builder - Class in software.amazon.smithy.build.model
-
Builder used to create a
SmithyBuildConfig
. - SmithyBuildException - Exception in software.amazon.smithy.build
-
Base exception thrown for any error that occurs while building.
- SmithyBuildException(String) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildException(String, Throwable) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildException(Throwable) - Constructor for exception software.amazon.smithy.build.SmithyBuildException
- SmithyBuildPlugin - Interface in software.amazon.smithy.build
-
Plugin extension class for SmithyBuild.
- SmithyBuildResult - Class in software.amazon.smithy.build
-
Encapsulates the result of running SmithyBuild.
- SmithyBuildResult.Builder - Class in software.amazon.smithy.build
-
Creates a SmithyBuildResult.
- software.amazon.smithy.build - package software.amazon.smithy.build
- software.amazon.smithy.build.model - package software.amazon.smithy.build.model
- software.amazon.smithy.build.plugins - package software.amazon.smithy.build.plugins
- software.amazon.smithy.build.processor - package software.amazon.smithy.build.processor
- software.amazon.smithy.build.transforms - package software.amazon.smithy.build.transforms
- sources(Collection<String>) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Replaces sources on the config.
- sources(Collection<Path>) - Method in class software.amazon.smithy.build.PluginContext.Builder
-
Replaces the path to models that are considered "source" models of the package being built.
- sources(Set<Path>) - Method in class software.amazon.smithy.build.TransformContext.Builder
- SourcesConflictException - Exception in software.amazon.smithy.build
-
Thrown when sources conflict in the source plugin.
- SourcesConflictException(String) - Constructor for exception software.amazon.smithy.build.SourcesConflictException
- SourcesPlugin - Class in software.amazon.smithy.build.plugins
-
Copies model sources into the sources plugin.
- SourcesPlugin() - Constructor for class software.amazon.smithy.build.plugins.SourcesPlugin
T
- toBuilder() - Method in class software.amazon.smithy.build.model.MavenConfig
- toBuilder() - Method in class software.amazon.smithy.build.model.MavenRepository
- toBuilder() - Method in class software.amazon.smithy.build.model.ProjectionConfig
- toBuilder() - Method in class software.amazon.smithy.build.model.SmithyBuildConfig
- toBuilder() - Method in class software.amazon.smithy.build.PluginContext
- toBuilder() - Method in class software.amazon.smithy.build.TransformContext
- transform(TransformContext) - Method in interface software.amazon.smithy.build.ProjectionTransformer
-
Transforms the given model using the provided
TransformContext
. - transform(TransformContext) - Method in class software.amazon.smithy.build.transforms.Apply
- transform(TransformContext) - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- transform(TransformContext) - Method in class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
- TransformConfig - Class in software.amazon.smithy.build.model
-
Transform configuration found in a projection.
- TransformConfig.Builder - Class in software.amazon.smithy.build.model
- TransformContext - Class in software.amazon.smithy.build
-
Context object used when applying a
ProjectionTransformer
. - TransformContext.Builder - Class in software.amazon.smithy.build
-
Builds a
TransformContext
. - transformer(ModelTransformer) - Method in class software.amazon.smithy.build.TransformContext.Builder
- transformFactory(Function<String, Optional<ProjectionTransformer>>) - Method in class software.amazon.smithy.build.SmithyBuild
-
Sets a factory function used to create transforms by name.
- transforms(Collection<TransformConfig>) - Method in class software.amazon.smithy.build.model.ProjectionConfig.Builder
-
Replaces the transforms of the projection.
- transformWithConfig(TransformContext, Apply.Config) - Method in class software.amazon.smithy.build.transforms.Apply
- transformWithConfig(TransformContext, ChangeStringEnumsToEnumShapes.Config) - Method in class software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes
- transformWithConfig(TransformContext, ChangeTypes.Config) - Method in class software.amazon.smithy.build.transforms.ChangeTypes
- transformWithConfig(TransformContext, ExcludeMetadata.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeMetadata
- transformWithConfig(TransformContext, ExcludeShapesBySelector.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesBySelector
- transformWithConfig(TransformContext, ExcludeShapesByTag.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTag
- transformWithConfig(TransformContext, ExcludeShapesByTrait.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeShapesByTrait
- transformWithConfig(TransformContext, ExcludeTags.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeTags
- transformWithConfig(TransformContext, ExcludeTraits.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeTraits
- transformWithConfig(TransformContext, ExcludeTraitsByTag.Config) - Method in class software.amazon.smithy.build.transforms.ExcludeTraitsByTag
- transformWithConfig(TransformContext, FilterSuppressions.Config) - Method in class software.amazon.smithy.build.transforms.FilterSuppressions
- transformWithConfig(TransformContext, FlattenNamespaces.Config) - Method in class software.amazon.smithy.build.transforms.FlattenNamespaces
- transformWithConfig(TransformContext, IncludeMetadata.Config) - Method in class software.amazon.smithy.build.transforms.IncludeMetadata
- transformWithConfig(TransformContext, IncludeNamespaces.Config) - Method in class software.amazon.smithy.build.transforms.IncludeNamespaces
- transformWithConfig(TransformContext, IncludeServices.Config) - Method in class software.amazon.smithy.build.transforms.IncludeServices
- transformWithConfig(TransformContext, IncludeShapesBySelector.Config) - Method in class software.amazon.smithy.build.transforms.IncludeShapesBySelector
- transformWithConfig(TransformContext, IncludeShapesByTag.Config) - Method in class software.amazon.smithy.build.transforms.IncludeShapesByTag
- transformWithConfig(TransformContext, IncludeTags.Config) - Method in class software.amazon.smithy.build.transforms.IncludeTags
- transformWithConfig(TransformContext, IncludeTraits.Config) - Method in class software.amazon.smithy.build.transforms.IncludeTraits
- transformWithConfig(TransformContext, IncludeTraitsByTag.Config) - Method in class software.amazon.smithy.build.transforms.IncludeTraitsByTag
- transformWithConfig(TransformContext, RemoveTraitDefinitions.Config) - Method in class software.amazon.smithy.build.transforms.RemoveTraitDefinitions
- transformWithConfig(TransformContext, RemoveUnusedShapes.Config) - Method in class software.amazon.smithy.build.transforms.RemoveUnusedShapes
- transformWithConfig(TransformContext, RenameShapes.Config) - Method in class software.amazon.smithy.build.transforms.RenameShapes
- transformWithConfig(TransformContext, T) - Method in class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
-
Executes the transform using the deserialized configuration object.
U
- UnknownProjectionException - Exception in software.amazon.smithy.build
-
Thrown when a projection extends from an unknown projection.
- UnknownProjectionException(String) - Constructor for exception software.amazon.smithy.build.UnknownProjectionException
- UnknownProjectionException(String, Throwable) - Constructor for exception software.amazon.smithy.build.UnknownProjectionException
- UnknownTransformException - Exception in software.amazon.smithy.build
-
Thrown when a mapper cannot be found.
- UnknownTransformException(String) - Constructor for exception software.amazon.smithy.build.UnknownTransformException
- UnknownTransformException(String, Throwable) - Constructor for exception software.amazon.smithy.build.UnknownTransformException
- url(String) - Method in class software.amazon.smithy.build.model.MavenRepository.Builder
V
- valueOf(String) - Static method in enum class software.amazon.smithy.build.MockManifest.StoreMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class software.amazon.smithy.build.MockManifest.StoreMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version(String) - Method in class software.amazon.smithy.build.model.SmithyBuildConfig.Builder
-
Sets the builder config file version.
- VERSION - Static variable in class software.amazon.smithy.build.SmithyBuild
-
The version of Smithy build.
W
- writeFile(String, InputStream) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of an
InputStream
. - writeFile(String, Reader) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a
Reader
. - writeFile(String, Class, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a resource loaded by calling
Class.getResourceAsStream(String)
. - writeFile(String, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a UTF-8 encoded file to the result.
- writeFile(Path, InputStream) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of an
InputStream
. - writeFile(Path, InputStream) - Method in class software.amazon.smithy.build.MockManifest
- writeFile(Path, Reader) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a
Reader
. - writeFile(Path, Reader) - Method in class software.amazon.smithy.build.MockManifest
- writeFile(Path, Class, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a file to the result using the contents of a resource loaded by calling
Class.getResourceAsStream(String)
. - writeFile(Path, String) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a UTF-8 encoded file to the result.
- writeJson(String, Node) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a Node artifact, converting it automatically to JSON.
- writeJson(Path, Node) - Method in interface software.amazon.smithy.build.FileManifest
-
Adds a Node artifact, converting it automatically to JSON.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form