Package ai.shipeasy.admin.model

Class ConnectorRecord

java.lang.Object
ai.shipeasy.admin.model.ConnectorRecord
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ConnectorRecord extends Object
A connector row. The encrypted credentials cipher backing the connector is intentionally never serialised.

  • Field Details

  • Constructor Details

    • ConnectorRecord

      public ConnectorRecord()

  • Method Details

    • id

      public ConnectorRecord id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Stable opaque connector id (a UUID).
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • projectId

      public ConnectorRecord projectId(@Nonnull String projectId)

    • getProjectId

      @Nonnull public String getProjectId()
      Id of the project the connector belongs to.
      Returns:
      projectId

    • setProjectId

      public void setProjectId(@Nonnull String projectId)

    • provider

      public ConnectorRecord provider(@Nonnull ConnectorProvider provider)

    • getProvider

      @Nonnull public ConnectorProvider getProvider()
      Get provider
      Returns:
      provider

    • setProvider

      public void setProvider(@Nonnull ConnectorProvider provider)

    • name

      public ConnectorRecord name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Human-readable connector label shown in the dashboard.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • enabled

      public ConnectorRecord enabled(@Nonnull Boolean enabled)

    • getEnabled

      @Nonnull public Boolean getEnabled()
      Whether the connector is active. OAuth providers are created `false` and flip to `true` only after the OAuth/config flow completes; trigger providers default to `true` on create. A disabled connector never dispatches and never auto-fires.
      Returns:
      enabled

    • setEnabled

      public void setEnabled(@Nonnull Boolean enabled)

    • events

      public ConnectorRecord events(@Nonnull List<ConnectorEvent> events)

    • addEventsItem

      public ConnectorRecord addEventsItem(ConnectorEvent eventsItem)

    • getEvents

      @Nonnull public List<ConnectorEvent> getEvents()
      Events this connector is subscribed to. Empty array = no auto-dispatch / no auto-fire (the connector can still be fired/tested manually).
      Returns:
      events

    • setEvents

      public void setEvents(@Nonnull List<ConnectorEvent> events)

    • config

      public ConnectorRecord config(@Nonnull Map<String,Object> config)

    • putConfigItem

      public ConnectorRecord putConfigItem(String key, Object configItem)

    • getConfig

      @Nonnull public Map<String,Object> getConfig()
      Provider-specific, non-secret configuration (e.g. a Google Sheets `spreadsheetId`/`sheetTitle`, a Slack channel ref, or a trigger's repo coordinates + routine id). Secrets are never stored here — they live in an encrypted credentials cipher that is never returned by the API.
      Returns:
      config

    • setConfig

      public void setConfig(@Nonnull Map<String,Object> config)

    • accountLabel

      public ConnectorRecord accountLabel(@Nullable String accountLabel)

    • getAccountLabel

      @Nullable public String getAccountLabel()
      Display label for the connected account / target (e.g. the OAuth account email, or a trigger's idempotency key such as its repo url or routine id). `null` until the connector is authenticated/configured.
      Returns:
      accountLabel

    • setAccountLabel

      public void setAccountLabel(@Nullable String accountLabel)

    • lastError

      public ConnectorRecord lastError(@Nullable String lastError)

    • getLastError

      @Nullable public String getLastError()
      Error message from the most recent failed dispatch/fire attempt, or `null` if the last attempt succeeded (or none has run).
      Returns:
      lastError

    • setLastError

      public void setLastError(@Nullable String lastError)

    • lastAttemptAt

      public ConnectorRecord lastAttemptAt(@Nullable String lastAttemptAt)

    • getLastAttemptAt

      @Nullable public String getLastAttemptAt()
      ISO-8601 timestamp of the most recent dispatch/fire attempt, or `null` if none has run.
      Returns:
      lastAttemptAt

    • setLastAttemptAt

      public void setLastAttemptAt(@Nullable String lastAttemptAt)

    • lastSuccessAt

      public ConnectorRecord lastSuccessAt(@Nullable String lastSuccessAt)

    • getLastSuccessAt

      @Nullable public String getLastSuccessAt()
      ISO-8601 timestamp of the most recent successful dispatch/fire, or `null` if none has succeeded. Preserved across later failures.
      Returns:
      lastSuccessAt

    • setLastSuccessAt

      public void setLastSuccessAt(@Nullable String lastSuccessAt)

    • createdAt

      public ConnectorRecord createdAt(@Nonnull String createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nonnull String createdAt)

    • updatedAt

      public ConnectorRecord updatedAt(@Nonnull String updatedAt)

    • getUpdatedAt

      @Nonnull public String getUpdatedAt()
      ISO-8601 timestamp of last mutation.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull String updatedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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