Package software.amazon.smithy.aws.traits

Class SdkServiceIdValidator

java.lang.Object
software.amazon.smithy.model.validation.AbstractValidator
software.amazon.smithy.aws.traits.SdkServiceIdValidator
All Implemented Interfaces:
software.amazon.smithy.model.validation.Validator
public final class SdkServiceIdValidator extends software.amazon.smithy.model.validation.AbstractValidator
Validates that SDK service IDs are correct and do not match any prohibited patterns.
  • Must match the following regex: ^[a-zA-Z][a-zA-Z0-9]*( [a-zA-Z0-9]+)*$
  • Must not contain "Amazon", "AWS", or "Aws"
  • Must not case-insensitively end with "Service", "Client", or "API".

  • Field Summary

    Fields inherited from interface software.amazon.smithy.model.validation.Validator

    MODEL_DEPRECATION, MODEL_ERROR

  • Constructor Summary

    Constructors
    Constructor
    Description
    SdkServiceIdValidator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isPreviouslyReleasedInvalidServiceId(String serviceId)
    Checks if the given value is a previously released but invalid service ID.
    List<software.amazon.smithy.model.validation.ValidationEvent>
    validate(software.amazon.smithy.model.Model model)
     
    static void
    validateServiceId(String serviceId)
    Validates a service ID value.

    Methods inherited from class software.amazon.smithy.model.validation.AbstractValidator

    createEvent, createEvent, danger, danger, error, error, getName, note, note, warning, warning

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SdkServiceIdValidator

      public SdkServiceIdValidator()

  • Method Details

    • validate

      public List<software.amazon.smithy.model.validation.ValidationEvent> validate(software.amazon.smithy.model.Model model)

    • isPreviouslyReleasedInvalidServiceId

      public static boolean isPreviouslyReleasedInvalidServiceId(String serviceId)
      Checks if the given value is a previously released but invalid service ID.
      Parameters:
      serviceId - Service ID value to check.
      Returns:
      Returns true if the service ID is approved but invalid.

    • validateServiceId

      public static void validateServiceId(String serviceId)
      Validates a service ID value.
      Parameters:
      serviceId - Service ID to validate.
      Throws:
      IllegalArgumentException - if the service ID is invalid.