Package ai.shipeasy.admin.model

Class CreateEventRequest

java.lang.Object
ai.shipeasy.admin.model.CreateEventRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateEventRequest extends Object
Body for `POST /api/admin/events`. Only `name` is required.

  • Field Details

  • Constructor Details

    • CreateEventRequest

      public CreateEventRequest()

  • Method Details

    • name

      public CreateEventRequest name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Event name. Starts with a letter, digit, or `_`; letters, digits, `_`, `-`, `.`; max 128 chars. Immutable after create — this is the handle metric queries reference.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • folder

      public CreateEventRequest 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)

    • description

      public CreateEventRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Optional human-readable description of the event.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • properties

      public CreateEventRequest properties(@Nullable List<ListEventsResponseInnerPropertiesInner> properties)

    • addPropertiesItem

      public CreateEventRequest addPropertiesItem(ListEventsResponseInnerPropertiesInner propertiesItem)

    • getProperties

      @Nullable public List<ListEventsResponseInnerPropertiesInner> getProperties()
      Typed properties declared on the event. Defaults to an empty list.
      Returns:
      properties

    • setProperties

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

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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