Package ai.shipeasy.admin.model

Class OpsMeasurePlanContext

java.lang.Object
ai.shipeasy.admin.model.OpsMeasurePlanContext
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OpsMeasurePlanContext extends Object
An assistant-proposed measurement plan: what it already built, what it still needs, and the event instrumentation you implement.

  • Field Details

  • Constructor Details

    • OpsMeasurePlanContext

      public OpsMeasurePlanContext()

  • Method Details

    • goal

      public OpsMeasurePlanContext goal(@Nullable String goal)

    • getGoal

      @Nullable public String getGoal()
      The customer's underlying intent in their own words — WHAT they want to learn or achieve and WHY, independent of the specific steps. The plan below is a best-effort proposal made without repo access; when the code reveals a better path, this goal is the target you optimize for, not literal step-adherence.
      Returns:
      goal

    • setGoal

      public void setGoal(@Nullable String goal)

    • created

      public OpsMeasurePlanContext created(@Nonnull List<MeasurePlanResource> created)

    • addCreatedItem

      public OpsMeasurePlanContext addCreatedItem(MeasurePlanResource createdItem)

    • getCreated

      @Nonnull public List<MeasurePlanResource> getCreated()
      Resources the assistant already created on approval (live now) — don't recreate them.
      Returns:
      created

    • setCreated

      public void setCreated(@Nonnull List<MeasurePlanResource> created)

    • pending

      public OpsMeasurePlanContext pending(@Nullable List<MeasurePlanResource> pending)

    • addPendingItem

      public OpsMeasurePlanContext addPendingItem(MeasurePlanResource pendingItem)

    • getPending

      @Nullable public List<MeasurePlanResource> getPending()
      Resources the assistant couldn't create yet (usually a metric whose backing event isn't emitted); create these after the instrumentation lands.
      Returns:
      pending

    • setPending

      public void setPending(@Nullable List<MeasurePlanResource> pending)

    • instrumentation

      public OpsMeasurePlanContext instrumentation(@Nonnull List<MeasurePlanStep> instrumentation)

    • addInstrumentationItem

      public OpsMeasurePlanContext addInstrumentationItem(MeasurePlanStep instrumentationItem)

    • getInstrumentation

      @Nonnull public List<MeasurePlanStep> getInstrumentation()
      The code instrumentation to implement before the metrics can collect data.
      Returns:
      instrumentation

    • setInstrumentation

      public void setInstrumentation(@Nonnull List<MeasurePlanStep> instrumentation)

    • putAdditionalProperty

      public OpsMeasurePlanContext putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the OpsMeasurePlanContext instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • 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 OpsMeasurePlanContext

    • fromJson

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

    • toJson

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