Package ai.shipeasy.admin.model

Class GetEventResponse

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

  • Field Details

  • Constructor Details

    • GetEventResponse

      public GetEventResponse()

  • Method Details

    • id

      public GetEventResponse id(@Nonnull String id)

    • getId

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

    • setId

      public void setId(@Nonnull String id)

    • name

      public GetEventResponse name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Event name — the handle metric queries reference.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • folder

      public GetEventResponse folder(@Nullable String folder)

    • getFolder

      @Nullable public String getFolder()
      Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder `checkout` named `new-cart` is referenced as `checkout/new-cart` from the SDK.
      Returns:
      folder

    • setFolder

      public void setFolder(@Nullable String folder)

    • description

      public GetEventResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Human-readable description, or `null` if none set.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • properties

      public GetEventResponse properties(@Nonnull List<ListEventsResponseInnerPropertiesInner> properties)

    • addPropertiesItem

      public GetEventResponse addPropertiesItem(ListEventsResponseInnerPropertiesInner propertiesItem)

    • getProperties

      @Nonnull public List<ListEventsResponseInnerPropertiesInner> getProperties()
      Typed properties declared on the event.
      Returns:
      properties

    • setProperties

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

    • pending

      public GetEventResponse pending(@Nonnull Integer pending)

    • getPending

      @Nonnull public Integer getPending()
      `1` if this is an auto-discovered name awaiting approval (metrics on it fail until approved), `0` if approved/usable. minimum: -9007199254740991 maximum: 9007199254740991
      Returns:
      pending

    • setPending

      public void setPending(@Nonnull Integer pending)

    • createdAt

      public GetEventResponse createdAt(@Nonnull String createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nonnull String createdAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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