Package ai.shipeasy.admin.model

Class MeasurePlanStep

java.lang.Object
ai.shipeasy.admin.model.MeasurePlanStep
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class MeasurePlanStep extends Object
One piece of code instrumentation a measurement plan still needs.

  • Field Details

  • Constructor Details

    • MeasurePlanStep

      public MeasurePlanStep()

  • Method Details

    • event

      public MeasurePlanStep event(@Nullable String event)

    • getEvent

      @Nullable public String getEvent()
      The event name the instrumentation should emit, when known.
      Returns:
      event

    • setEvent

      public void setEvent(@Nullable String event)

    • attribute

      public MeasurePlanStep attribute(@Nullable String attribute)

    • getAttribute

      @Nullable public String getAttribute()
      A new user attribute the project must start sending on its identify/evaluate context (when a gate's targeting needs a field that doesn't exist yet).
      Returns:
      attribute

    • setAttribute

      public void setAttribute(@Nullable String attribute)

    • label

      public MeasurePlanStep label(@Nonnull String label)

    • getLabel

      @Nonnull public String getLabel()
      Short human-readable name for the moment being instrumented.
      Returns:
      label

    • setLabel

      public void setLabel(@Nonnull String label)

    • description

      public MeasurePlanStep description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      What to track and why, described conceptually — which user moment/action to capture and what it enables. Deliberately NOT a file path (the assistant has no repo access and can't name real files); you locate the call site yourself.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • properties

      public MeasurePlanStep properties(@Nullable List<String> properties)

    • addPropertiesItem

      public MeasurePlanStep addPropertiesItem(String propertiesItem)

    • getProperties

      @Nullable public List<String> getProperties()
      Event properties the downstream metric needs attached (e.g. `method`, `plan`).
      Returns:
      properties

    • setProperties

      public void setProperties(@Nullable List<String> properties)

    • putAdditionalProperty

      public MeasurePlanStep 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 MeasurePlanStep 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 MeasurePlanStep

    • fromJson

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

    • toJson

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