Package ai.shipeasy.admin.model

Class CreateAttributeRequest

java.lang.Object
ai.shipeasy.admin.model.CreateAttributeRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateAttributeRequest extends Object
Body for `POST /api/admin/attributes`. Declares a targeting attribute.

  • Field Details

  • Constructor Details

    • CreateAttributeRequest

      public CreateAttributeRequest()

  • Method Details

    • name

      public CreateAttributeRequest name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Attribute key (lowercase alphanumeric start, then letters/digits/`_`/`-`; max 64 chars). Immutable after create.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • type

      public CreateAttributeRequest type(@Nonnull AttributeType type)

    • getType

      @Nonnull public AttributeType getType()
      Get type
      Returns:
      type

    • setType

      public void setType(@Nonnull AttributeType type)

    • enumValues

      public CreateAttributeRequest enumValues(@Nullable List<String> enumValues)

    • addEnumValuesItem

      public CreateAttributeRequest addEnumValuesItem(String enumValuesItem)

    • getEnumValues

      @Nullable public List<String> getEnumValues()
      Allowed values when `type` is `enum` (required in that case — 422 otherwise); `null` for non-enum types.
      Returns:
      enumValues

    • setEnumValues

      public void setEnumValues(@Nullable List<String> enumValues)

    • required

      public CreateAttributeRequest required(@Nullable Boolean required)

    • getRequired

      @Nullable public Boolean getRequired()
      Whether the attribute must be present on the evaluation context.
      Returns:
      required

    • setRequired

      public void setRequired(@Nullable Boolean required)

    • description

      public CreateAttributeRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Optional human note shown in the dashboard.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • sdkPath

      public CreateAttributeRequest sdkPath(@Nullable String sdkPath)

    • getSdkPath

      @Nullable public String getSdkPath()
      Optional dotted path the SDK reads the value from.
      Returns:
      sdkPath

    • setSdkPath

      public void setSdkPath(@Nullable String sdkPath)

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

    • fromJson

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

    • toJson

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