Index
All Classes and Interfaces|All Packages
A
- AbbreviationNameValidator - Class in software.amazon.smithy.linters
-
Emits a validation event if shapes or member names do not use strict camelCasing (e.g., XmlRequest is preferred over XMLRequest).
- AbbreviationNameValidator.Config - Class in software.amazon.smithy.linters
-
AbbreviationName configuration settings.
- AbbreviationNameValidator.Provider - Class in software.amazon.smithy.linters
- AUTO - Enum constant in enum class software.amazon.smithy.linters.CamelCaseValidator.MemberNameHandling
-
Member names are serialized using either all lower camel or all upper camel, but not a mixture.
C
- CamelCaseValidator - Class in software.amazon.smithy.linters
-
Emits a validation event if shapes at a specific location do not match the desired camel casing format.
- CamelCaseValidator.Config - Class in software.amazon.smithy.linters
-
CamelCase configuration settings.
- CamelCaseValidator.MemberNameHandling - Enum Class in software.amazon.smithy.linters
- CamelCaseValidator.Provider - Class in software.amazon.smithy.linters
- Config() - Constructor for class software.amazon.smithy.linters.AbbreviationNameValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.CamelCaseValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.MissingClientOptionalTrait.Config
- Config() - Constructor for class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.RepeatedShapeNameValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.ReservedWordsValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator.Config
- Config() - Constructor for class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
G
- getAdditionalPatterns() - Method in class software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator.Config
- getAllowedAbbreviations() - Method in class software.amazon.smithy.linters.AbbreviationNameValidator.Config
-
A list of abbreviation strings to permit.
- getExactMatch() - Method in class software.amazon.smithy.linters.RepeatedShapeNameValidator.Config
- getExcludeDefaults() - Method in class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
- getExcludeDefaults() - Method in class software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
- getInputMembersRequirePagination() - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
- getMemberNames() - Method in class software.amazon.smithy.linters.CamelCaseValidator.Config
-
Gets how member names are to be cased.
- getOutputMembersRequirePagination() - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
- getPrefixes() - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
- getReserved() - Method in class software.amazon.smithy.linters.ReservedWordsValidator.Config
- getSuggestAlternatives() - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
- getTerms() - Method in class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
- getTerms() - Method in class software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
- getVerbs() - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
- getVerbsRequirePagination() - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
- getVerbsSuggestPagination() - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
I
- InputOutputStructureReuseValidator - Class in software.amazon.smithy.linters
-
Validates that all operations define input and output structures that are marked with the input and output traits.
- InputOutputStructureReuseValidator() - Constructor for class software.amazon.smithy.linters.InputOutputStructureReuseValidator
- InputOutputStructureReuseValidator.Provider - Class in software.amazon.smithy.linters
L
- LOWER - Enum constant in enum class software.amazon.smithy.linters.CamelCaseValidator.MemberNameHandling
-
Member names are serialized using lower camel case (e.g., fooBar).
M
- MissingClientOptionalTrait - Class in software.amazon.smithy.linters
-
Validates that the clientOptional trait is applied based on the rules defined in the validator.
- MissingClientOptionalTrait(MissingClientOptionalTrait.Config) - Constructor for class software.amazon.smithy.linters.MissingClientOptionalTrait
- MissingClientOptionalTrait.Config - Class in software.amazon.smithy.linters
-
MissingClientOptionalTrait configuration settings.
- MissingClientOptionalTrait.Provider - Class in software.amazon.smithy.linters
- MissingPaginatedTraitValidator - Class in software.amazon.smithy.linters
-
Checks if an operation should be paginated but is not.
- MissingPaginatedTraitValidator.Config - Class in software.amazon.smithy.linters
- MissingPaginatedTraitValidator.Provider - Class in software.amazon.smithy.linters
- MissingSensitiveTraitValidator - Class in software.amazon.smithy.linters
-
Validates that shapes and members that possibly contain sensitive data are marked with the sensitive trait.
- MissingSensitiveTraitValidator.Config - Class in software.amazon.smithy.linters
-
MissingSensitiveTrait configuration.
- MissingSensitiveTraitValidator.Provider - Class in software.amazon.smithy.linters
N
- NoninclusiveTermsValidator - Class in software.amazon.smithy.linters
-
Validates that all shape names and values do not contain non-inclusive terms.
- NoninclusiveTermsValidator.Config - Class in software.amazon.smithy.linters
-
NoninclusiveTermsValidator configuration.
- NoninclusiveTermsValidator.Provider - Class in software.amazon.smithy.linters
O
- onRequiredOrDefault() - Method in class software.amazon.smithy.linters.MissingClientOptionalTrait.Config
-
Whether clientOptional is required for all members marked as required or default.
- onRequiredOrDefault(boolean) - Method in class software.amazon.smithy.linters.MissingClientOptionalTrait.Config
- onRequiredStructureOrUnion() - Method in class software.amazon.smithy.linters.MissingClientOptionalTrait.Config
-
Whether clientOptional is required for members marked as required that target structures or unions (shapes with no zero value, meaning it's impossible to later remove the required trait and replace it with the default trait).
- onRequiredStructureOrUnion(boolean) - Method in class software.amazon.smithy.linters.MissingClientOptionalTrait.Config
P
- Provider() - Constructor for class software.amazon.smithy.linters.AbbreviationNameValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.CamelCaseValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.InputOutputStructureReuseValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.MissingClientOptionalTrait.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.NoninclusiveTermsValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.RepeatedShapeNameValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.ReservedWordsValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.StandardOperationVerbValidator.Provider
- Provider() - Constructor for class software.amazon.smithy.linters.StutteredShapeNameValidator.Provider
-
Deprecated.
R
- RepeatedShapeNameValidator - Class in software.amazon.smithy.linters
-
Validates that structure members and union member names do not repeat their shape name as prefixes of their member or tag names.
- RepeatedShapeNameValidator.Config - Class in software.amazon.smithy.linters
- RepeatedShapeNameValidator.Provider - Class in software.amazon.smithy.linters
- ReservedWords() - Constructor for class software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
- ReservedWordsValidator - Class in software.amazon.smithy.linters
-
Emits validation events for a configuration of reserved words.
- ReservedWordsValidator.Config - Class in software.amazon.smithy.linters
-
ReservedWords validator configuration.
- ReservedWordsValidator.Provider - Class in software.amazon.smithy.linters
- ReservedWordsValidator.ReservedWords - Class in software.amazon.smithy.linters
-
A single reserved words configuration.
S
- setAdditionalPatterns(List<Pattern>) - Method in class software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator.Config
-
Sets a list of additional regular expression patterns that indicate a value carries a timestamp.
- setAllowedAbbreviations(List<String>) - Method in class software.amazon.smithy.linters.AbbreviationNameValidator.Config
- setExactMatch(boolean) - Method in class software.amazon.smithy.linters.RepeatedShapeNameValidator.Config
- setExcludeDefaults(boolean) - Method in class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
- setExcludeDefaults(boolean) - Method in class software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
- setInputMembersRequirePagination(Set<String>) - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
-
Sets the input member names that indicate an operation requires pagination.
- setMemberNames(CamelCaseValidator.MemberNameHandling) - Method in class software.amazon.smithy.linters.CamelCaseValidator.Config
- setOutputMembersRequirePagination(Set<String>) - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
-
Sets the output member names that indicate the operation requires pagination.
- setPrefixes(List<String>) - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
-
Sets the list of acceptable verb prefixed (e.g., Batch).
- setReason(String) - Method in class software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
-
Sets the reason for why the words are reserved.
- setReserved(List<ReservedWordsValidator.ReservedWords>) - Method in class software.amazon.smithy.linters.ReservedWordsValidator.Config
-
Sets the reserved words to validate.
- setSelector(Selector) - Method in class software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
-
Sets the selector to use for determining which shapes to validate.
- setSuggestAlternatives(Map<String, List<String>>) - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
-
Sets a map of invalid verbs to suggested alternatives.
- setTerms(List<String>) - Method in class software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
- setTerms(List<String>) - Method in class software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
-
Sets the list of reserved word terms to match based on word boundaries.
- setTerms(Map<String, List<String>>) - Method in class software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
- setVerbs(List<String>) - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator.Config
-
Sets the list of standard operation verbs.
- setVerbsRequirePagination(Set<String>) - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
-
Sets the list of verbs that require pagination.
- setVerbsSuggestPagination(Set<String>) - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
-
Sets the verbs that suggest the operation should be paginated.
- setWords(List<String>) - Method in class software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
-
Sets the list of reserved word definitions.
- ShouldHaveUsedTimestampValidator - Class in software.amazon.smithy.linters
-
Validates that shapes that have names that appear to be time values are actually modeled with a timestamp shape.
- ShouldHaveUsedTimestampValidator.Config - Class in software.amazon.smithy.linters
- ShouldHaveUsedTimestampValidator.Provider - Class in software.amazon.smithy.linters
- software.amazon.smithy.linters - package software.amazon.smithy.linters
- StandardOperationVerbValidator - Class in software.amazon.smithy.linters
-
Validates that operation shape names start with standard verbs.
- StandardOperationVerbValidator.Config - Class in software.amazon.smithy.linters
-
StandardOperationVerb configuration settings.
- StandardOperationVerbValidator.Provider - Class in software.amazon.smithy.linters
- StutteredShapeNameValidator - Class in software.amazon.smithy.linters
-
Deprecated.
- StutteredShapeNameValidator() - Constructor for class software.amazon.smithy.linters.StutteredShapeNameValidator
-
Deprecated.
- StutteredShapeNameValidator.Provider - Class in software.amazon.smithy.linters
-
Deprecated.
U
- UPPER - Enum constant in enum class software.amazon.smithy.linters.CamelCaseValidator.MemberNameHandling
-
Member names are serialized using upper camel case (e.g., FooBar).
V
- validate(Model) - Method in class software.amazon.smithy.linters.AbbreviationNameValidator
- validate(Model) - Method in class software.amazon.smithy.linters.CamelCaseValidator
- validate(Model) - Method in class software.amazon.smithy.linters.InputOutputStructureReuseValidator
- validate(Model) - Method in class software.amazon.smithy.linters.MissingClientOptionalTrait
- validate(Model) - Method in class software.amazon.smithy.linters.MissingPaginatedTraitValidator
- validate(Model) - Method in class software.amazon.smithy.linters.MissingSensitiveTraitValidator
-
Finds shapes without the sensitive trait that possibly contain sensitive data, based on the shape/member name and the list of key words and phrases.
- validate(Model) - Method in class software.amazon.smithy.linters.NoninclusiveTermsValidator
-
Runs a full text scan on a given model and stores the resulting TextOccurrences objects.
- validate(Model) - Method in class software.amazon.smithy.linters.RepeatedShapeNameValidator
- validate(Model) - Method in class software.amazon.smithy.linters.ReservedWordsValidator
- validate(Model) - Method in class software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator
- validate(Model) - Method in class software.amazon.smithy.linters.StandardOperationVerbValidator
- validate(Model) - Method in class software.amazon.smithy.linters.StutteredShapeNameValidator
-
Deprecated.
- valueOf(String) - Static method in enum class software.amazon.smithy.linters.CamelCaseValidator.MemberNameHandling
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class software.amazon.smithy.linters.CamelCaseValidator.MemberNameHandling
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages