Package ai.vectros.types

Class ClientRequest

java.lang.Object
ai.vectros.types.ClientRequest
public final class ClientRequest extends Object

  • Method Details

    • getExternalId

      public String getExternalId()
      Returns:
      Your own unique identifier for this client. Used for idempotent create: if a client with this externalId already exists, it is returned instead of creating a duplicate.

    • getName

      public Optional<String> getName()
      Returns:
      Display name for this client.

    • getStatus

      public Optional<ClientRequestStatus> getStatus()
      Returns:
      Lifecycle status of the client. ACTIVE clients can be used normally; SUSPENDED clients are retained but blocked from new operations. Defaults to ACTIVE.

    • getOrgId

      public Optional<String> getOrgId()
      Returns:
      The organization this client belongs to. Must be the Vectros-assigned UUID of an org created via POST /v1/orgs; use GET /v1/orgs?externalId= to resolve your own identifier to this UUID.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Free-form key-value attributes to store with this client — handy for keeping extra data from your system without defining a schema. On update, the supplied object replaces the stored payload in full (it is not key-merged); omit it to leave the payload unchanged.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      Optional ID of a schema (created via POST /v1/schemas) that validates this client's payload and drives its lookup indexing. When set, the schema must belong to your account, the payload is validated against the schema's fields on save, and the schema's declared lookup fields become queryable via GET /v1/clients?type=...&field=...&value=.... When omitted, the payload is free-form and no lookup rows are written. On update, omit this field to leave it unchanged; once set, it cannot be cleared.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ClientRequest.ExternalIdStage builder()