Package ai.shipeasy.admin.model

Class NotifyOpsRequest

java.lang.Object
ai.shipeasy.admin.model.NotifyOpsRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class NotifyOpsRequest extends Object
Body for `POST /api/admin/notifications`. In `title`, `summary`, and each step, reference admin entities inline with tokens — `#42` (feedback item), `@gate:<name>` (alias `@flag:`), `@experiment:<name>` (`@exp:`), `@config:<name>`, `@killswitch:<name>` (`@ks:`), `@metric:<name>`, `@universe:<name>`, `@alert:<name>` — where `<name>` is the entity's immutable name/slug (e.g. `features.checkout`). The dashboard renders each token as a live hover chip deep-linking to the entity; tokens degrade to plain text elsewhere, so they're always safe to use.

  • Field Details

  • Constructor Details

    • NotifyOpsRequest

      public NotifyOpsRequest()

  • Method Details

    • title

      public NotifyOpsRequest title(@Nonnull String title)

    • getTitle

      @Nonnull public String getTitle()
      One-line headline of what's blocked.
      Returns:
      title

    • setTitle

      public void setTitle(@Nonnull String title)

    • summary

      public NotifyOpsRequest summary(@Nonnull String summary)

    • getSummary

      @Nonnull public String getSummary()
      One sentence: why it can't be fixed in code. Renders markdown.
      Returns:
      summary

    • setSummary

      public void setSummary(@Nonnull String summary)

    • steps

      public NotifyOpsRequest steps(@Nullable List<String> steps)

    • addStepsItem

      public NotifyOpsRequest addStepsItem(String stepsItem)

    • getSteps

      @Nullable public List<String> getSteps()
      Ordered steps the human should take to unblock — self-contained (the human reads only this card, not the agent's transcript), 3–6 steps, each naming the exact file, command, env var, or dashboard page. Renders markdown.
      Returns:
      steps

    • setSteps

      public void setSteps(@Nullable List<String> steps)

    • href

      public NotifyOpsRequest href(@Nullable String href)

    • getHref

      @Nullable public String getHref()
      Dashboard-relative deep link to the related item. `null` is accepted and treated as \"no link\".
      Returns:
      href

    • setHref

      public void setHref(@Nullable String href)

    • dedupeKey

      public NotifyOpsRequest dedupeKey(@Nullable String dedupeKey)

    • getDedupeKey

      @Nullable public String getDedupeKey()
      Stable per-escalation key (e.g. `feedback:7`) so re-runs dedupe to one row.
      Returns:
      dedupeKey

    • setDedupeKey

      public void setDedupeKey(@Nullable String dedupeKey)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to NotifyOpsRequest

    • fromJson

      public static NotifyOpsRequest fromJson(String jsonString) throws IOException
      Create an instance of NotifyOpsRequest given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of NotifyOpsRequest
      Throws:
      IOException - if the JSON string is invalid with respect to NotifyOpsRequest

    • toJson

      public String toJson()
      Convert an instance of NotifyOpsRequest to an JSON string
      Returns:
      JSON string