Package ai.shipeasy.admin.model

Class UpdateGateRequest

java.lang.Object
ai.shipeasy.admin.model.UpdateGateRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class UpdateGateRequest extends Object
Body for `PATCH /api/admin/gates/{id}`. Partial — only supplied fields change. Array fields (`rules`, `stack`) replace, not merge.

  • Field Details

  • Constructor Details

    • UpdateGateRequest

      public UpdateGateRequest()

  • Method Details

    • rolloutPct

      public UpdateGateRequest rolloutPct(@Nullable Integer rolloutPct)

    • getRolloutPct

      @Nullable public Integer getRolloutPct()
      New rollout in **basis points** (0–10000 = 0%–100%) — `100` here means **1%**. Use `rollout_percent` (0–100) below for percent. Omit both to leave unchanged. minimum: 0 maximum: 10000
      Returns:
      rolloutPct

    • setRolloutPct

      public void setRolloutPct(@Nullable Integer rolloutPct)

    • rolloutPercent

      public UpdateGateRequest rolloutPercent(@Nullable BigDecimal rolloutPercent)

    • getRolloutPercent

      @Nullable public BigDecimal getRolloutPercent()
      New rollout as a **percentage** (0–100). Friendlier alias for `rollout_pct`; converted internally. Wins over `rollout_pct` if both are supplied. Omit both to leave unchanged. minimum: 0 maximum: 100
      Returns:
      rolloutPercent

    • setRolloutPercent

      public void setRolloutPercent(@Nullable BigDecimal rolloutPercent)

    • rules

      public UpdateGateRequest rules(@Nullable List<ListGatesResponseDataInnerRulesInner> rules)

    • addRulesItem

      public UpdateGateRequest addRulesItem(ListGatesResponseDataInnerRulesInner rulesItem)

    • getRules

      @Nullable public List<ListGatesResponseDataInnerRulesInner> getRules()
      Replaces the rule list wholesale. To add a value to an `in` rule, send the full new `rules` array with the augmented `value` (e.g. previous `['US','CA']` → `['US','CA','GB']`).
      Returns:
      rules

    • setRules

      public void setRules(@Nullable List<ListGatesResponseDataInnerRulesInner> rules)

    • enabled

      public UpdateGateRequest enabled(@Nullable Boolean enabled)

    • getEnabled

      @Nullable public Boolean getEnabled()
      Master switch. `false` makes the gate evaluate to `false` for every caller regardless of `rollout_pct`, `rules`, or `stack` — use as kill switch.
      Returns:
      enabled

    • setEnabled

      public void setEnabled(@Nullable Boolean enabled)

    • stack

      public UpdateGateRequest stack(@Nullable List<ListGatesResponseDataInnerStackInner> stack)

    • addStackItem

      public UpdateGateRequest addStackItem(ListGatesResponseDataInnerStackInner stackItem)

    • getStack

      @Nullable public List<ListGatesResponseDataInnerStackInner> getStack()
      Replaces the gatekeeper stack wholesale. Send `null` to revert to flat `rules` + `rollout_pct` evaluation.
      Returns:
      stack

    • setStack

      public void setStack(@Nullable List<ListGatesResponseDataInnerStackInner> stack)

    • title

      public UpdateGateRequest title(@Nullable String title)

    • getTitle

      @Nullable public String getTitle()
      Human-readable title shown in the dashboard. Free-form, no key format constraint.
      Returns:
      title

    • setTitle

      public void setTitle(@Nullable String title)

    • description

      public UpdateGateRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Long-form description / runbook. Markdown is rendered in the dashboard.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • folder

      public UpdateGateRequest folder(@Nullable String folder)

    • getFolder

      @Nullable public String getFolder()
      Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
      Returns:
      folder

    • setFolder

      public void setFolder(@Nullable String folder)

    • group

      public UpdateGateRequest group(@Nullable String group)

    • getGroup

      @Nullable public String getGroup()
      Group label for dashboard organisation (e.g. team or product area).
      Returns:
      group

    • setGroup

      public void setGroup(@Nullable String group)

    • ownerEmail

      public UpdateGateRequest ownerEmail(@Nullable String ownerEmail)

    • getOwnerEmail

      @Nullable public String getOwnerEmail()
      Owner contact. Displayed verbatim; not used for auth.
      Returns:
      ownerEmail

    • setOwnerEmail

      public void setOwnerEmail(@Nullable String ownerEmail)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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