Package ai.shipeasy.admin.model

Class GetMetricResponse

java.lang.Object
ai.shipeasy.admin.model.GetMetricResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class GetMetricResponse extends Object
A metric definition.

  • Field Details

  • Constructor Details

    • GetMetricResponse

      public GetMetricResponse()

  • Method Details

    • id

      public GetMetricResponse id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Stable opaque metric id.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • name

      public GetMetricResponse name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Metric key.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • folder

      public GetMetricResponse folder(@Nullable String folder)

    • getFolder

      @Nullable public String getFolder()
      Folder grouping the metric, or `null`.
      Returns:
      folder

    • setFolder

      public void setFolder(@Nullable String folder)

    • eventName

      public GetMetricResponse eventName(@Nonnull String eventName)

    • getEventName

      @Nonnull public String getEventName()
      Source event name (camelCase in response).
      Returns:
      eventName

    • setEventName

      public void setEventName(@Nonnull String eventName)

    • query

      public GetMetricResponse query(@Nullable String query)

    • getQuery

      @Nullable public String getQuery()
      Rendered DSL text form of the query, or `null` if it could not be rendered.
      Returns:
      query

    • setQuery

      public void setQuery(@Nullable String query)

    • queryIr

      public GetMetricResponse queryIr(@Nonnull QueryIr queryIr)

    • getQueryIr

      @Nonnull public QueryIr getQueryIr()
      Get queryIr
      Returns:
      queryIr

    • setQueryIr

      public void setQueryIr(@Nonnull QueryIr queryIr)

    • direction

      public GetMetricResponse direction(@Nullable GetMetricResponse.DirectionEnum direction)

    • getDirection

      @Nullable public GetMetricResponse.DirectionEnum getDirection()
      Desired direction of movement. `higher_better` (default), `lower_better`, or `neutral` (guardrail).
      Returns:
      direction

    • setDirection

      public void setDirection(@Nullable GetMetricResponse.DirectionEnum direction)

    • winsorizePct

      public GetMetricResponse winsorizePct(@Nullable BigDecimal winsorizePct)

    • getWinsorizePct

      @Nullable public BigDecimal getWinsorizePct()
      Winsorise percentile applied to the metric.
      Returns:
      winsorizePct

    • setWinsorizePct

      public void setWinsorizePct(@Nullable BigDecimal winsorizePct)

    • defaultMinEffectOfInterest

      public GetMetricResponse defaultMinEffectOfInterest(@Nullable BigDecimal defaultMinEffectOfInterest)

    • getDefaultMinEffectOfInterest

      @Nullable public BigDecimal getDefaultMinEffectOfInterest()
      Metric-level default minimum effect of interest (relative, 0–1), or `null`.
      Returns:
      defaultMinEffectOfInterest

    • setDefaultMinEffectOfInterest

      public void setDefaultMinEffectOfInterest(@Nullable BigDecimal defaultMinEffectOfInterest)

    • createdAt

      public GetMetricResponse createdAt(@Nullable String createdAt)

    • getCreatedAt

      @Nullable public String getCreatedAt()
      ISO-8601 creation timestamp.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)

    • updatedAt

      public GetMetricResponse updatedAt(@Nullable String updatedAt)

    • getUpdatedAt

      @Nullable public String getUpdatedAt()
      ISO-8601 last-update timestamp.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable String updatedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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