Package ai.vectros.types

Class ClientResponse

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

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new client. True when a new client was created; false when a client with the same externalId already existed and was returned unchanged (idempotent create) or updated (when ?upsert=true). Present only on the create response (POST /v1/clients); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing client was returned.

    • getId

      public Optional<String> getId()
      Returns:
      The Vectros-assigned UUID for this client. Use this ID when referencing the client in token minting, record ownership, and filters.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Your own identifier for this client, supplied when it was created.

    • getName

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

    • getStatus

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

    • getOrgId

      public Optional<String> getOrgId()
      Returns:
      The Vectros-assigned UUID of the organization this client belongs to, or null if the client is not associated with an org.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Free-form key-value attributes stored with this client. Sensitive fields are returned as [redacted] unless your token grants the sensitive-reveal scope for the client's schema.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      The ID of the schema that validates this client's payload and drives its lookup indexing, or null if the client is not schema-bound.

    • getSchemaVersion

      public Optional<Integer> getSchemaVersion()
      Returns:
      The version of the governing schema that was in effect when this client was last written. The client keeps the version it was stamped with even after the schema is edited. Null when the client is not schema-bound.

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the client was created, as an ISO-8601 UTC timestamp.

    • 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 ClientResponse.Builder builder()