Package software.amazon.smithy.model.validation

Class ValidationEvent.Builder

java.lang.Object
software.amazon.smithy.model.validation.ValidationEvent.Builder
All Implemented Interfaces:
SmithyBuilder<ValidationEvent>
Enclosing class:
ValidationEvent
public static final class ValidationEvent.Builder extends Object implements SmithyBuilder<ValidationEvent>
Builds ValidationEvent values.

  • Method Details

    • message

      public ValidationEvent.Builder message(String eventMessage)
      Sets the required message of the event.
      Parameters:
      eventMessage - Message to set.
      Returns:
      Returns the builder.

    • message

      public ValidationEvent.Builder message(String eventMessage, Object... placeholders)

    • severity

      public ValidationEvent.Builder severity(Severity severity)
      Sets the required severity of the event.
      Parameters:
      severity - Event severity.
      Returns:
      Returns the builder.

    • eventId

      public ValidationEvent.Builder eventId(String eventId)
      Deprecated.
      Use the id(String eventId) setter to match the node format.
      Sets the required event ID of the event.
      Parameters:
      eventId - Event ID.
      Returns:
      Returns the builder.

    • id

      public ValidationEvent.Builder id(String eventId)
      Sets the required event ID of the event.
      Parameters:
      eventId - Event ID.
      Returns:
      Returns the builder.

    • sourceLocation

      public ValidationEvent.Builder sourceLocation(FromSourceLocation sourceLocation)
      Sets the source location of where the event occurred.
      Parameters:
      sourceLocation - Event source location.
      Returns:
      Returns the builder.

    • shapeId

      public <T extends ToShapeId> ValidationEvent.Builder shapeId(T toShapeId)
      Sets the shape ID related to the event.
      Type Parameters:
      T - Value to convert to a shape ID.
      Parameters:
      toShapeId - Shape ID.
      Returns:
      Returns the builder.

    • shape

      public ValidationEvent.Builder shape(Shape encounteredShape)
      Sets the shape ID and source location based on a shape.
      Parameters:
      encounteredShape - Shape.
      Returns:
      Returns the builder.

    • suppressionReason

      public ValidationEvent.Builder suppressionReason(String eventSuppressionReason)
      Sets a reason for suppressing the event.

      This is only relevant if the severity is SUPPRESSED.

      Parameters:
      eventSuppressionReason - Event suppression reason.
      Returns:
      Returns the builder.

    • hint

      public ValidationEvent.Builder hint(String hint)
      Sets an optional hint adding more detail about how to fix a specific issue.
      Parameters:
      hint - Hint to set
      Returns:
      Returns the builder.

    • build

      public ValidationEvent build()
      Description copied from interface: SmithyBuilder
      Creates an immutable object that is created from the properties that have been set on the builder.
      Specified by:
      build in interface SmithyBuilder<ValidationEvent>
      Returns:
      an instance of T