Package ai.vectros.types

Class UserResponse.Builder

java.lang.Object

ai.vectros.types.UserResponse.Builder

Enclosing class:

UserResponse

public static final class UserResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
UserResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
UserResponse.Builder	additionalProperty(String key, Object value)
UserResponse	build()
UserResponse.Builder	created(Boolean created)
UserResponse.Builder	created(Optional<Boolean> created)	Whether this call created a new user.
UserResponse.Builder	createdAt(String createdAt)
UserResponse.Builder	createdAt(Optional<String> createdAt)	When the user was created, as an ISO-8601 UTC timestamp.
UserResponse.Builder	email(String email)
UserResponse.Builder	email(Optional<String> email)	The user's email address.
UserResponse.Builder	externalId(String externalId)
UserResponse.Builder	externalId(Optional<String> externalId)	Your own identifier for this user, supplied when the user was created.
UserResponse.Builder	externalSubject(String externalSubject)
UserResponse.Builder	externalSubject(Optional<String> externalSubject)	The user's identifier in your own authentication system (for example, a Cognito sub or Auth0 user ID).
UserResponse.Builder	from(UserResponse other)
UserResponse.Builder	id(String id)
UserResponse.Builder	id(Optional<String> id)	The Vectros-assigned UUID for this user.
UserResponse.Builder	payload(Map<String,Object> payload)
UserResponse.Builder	payload(Optional<Map<String,Object>> payload)	Arbitrary key-value attributes stored on this user.
UserResponse.Builder	schemaId(String schemaId)
UserResponse.Builder	schemaId(Optional<String> schemaId)	The ID of the record schema that governs this user's payload validation and lookup indexing, or null if the user is not bound to a schema.
UserResponse.Builder	schemaVersion(Integer schemaVersion)
UserResponse.Builder	schemaVersion(Optional<Integer> schemaVersion)	The version of the governing schema captured at the time this user was last written.
UserResponse.Builder	status(UserResponseStatus status)
UserResponse.Builder	status(Optional<UserResponseStatus> status)	The user's lifecycle status.
UserResponse.Builder	type(UserResponseType type)
UserResponse.Builder	type(Optional<UserResponseType> type)	The kind of user: HUMAN for a real person, or SERVICE for a bot, agent, or automated integration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public UserResponse.Builder from(UserResponse other)

created

public UserResponse.Builder created(Optional<Boolean> created)

Whether this call created a new user. True when a new user was created; false when a user 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/users); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing user was returned.

created

public UserResponse.Builder created(Boolean created)

id

public UserResponse.Builder id(Optional<String> id)

The Vectros-assigned UUID for this user. Use this ID when referencing the user in token minting, record ownership, and filters.

id

public UserResponse.Builder id(String id)

externalId

public UserResponse.Builder externalId(Optional<String> externalId)

Your own identifier for this user, supplied when the user was created.

externalId

public UserResponse.Builder externalId(String externalId)

email

public UserResponse.Builder email(Optional<String> email)

The user's email address.

email

public UserResponse.Builder email(String email)

status

public UserResponse.Builder status(Optional<UserResponseStatus> status)

The user's lifecycle status. ACTIVE and SUSPENDED apply to normal users; PENDING marks an invited user who has not yet completed acceptance.

status

public UserResponse.Builder status(UserResponseStatus status)

type

public UserResponse.Builder type(Optional<UserResponseType> type)

The kind of user: HUMAN for a real person, or SERVICE for a bot, agent, or automated integration. Users created before this field existed are reported as HUMAN.

type

public UserResponse.Builder type(UserResponseType type)

payload

public UserResponse.Builder payload(Optional<Map<String,Object>> payload)

Arbitrary key-value attributes stored on this user.

payload

public UserResponse.Builder payload(Map<String,Object> payload)

schemaId

public UserResponse.Builder schemaId(Optional<String> schemaId)

The ID of the record schema that governs this user's payload validation and lookup indexing, or null if the user is not bound to a schema.

schemaId

public UserResponse.Builder schemaId(String schemaId)

schemaVersion

public UserResponse.Builder schemaVersion(Optional<Integer> schemaVersion)

The version of the governing schema captured at the time this user was last written. The user keeps the version it was stamped with even after the schema is edited. Null when the user is not bound to a schema.

schemaVersion

public UserResponse.Builder schemaVersion(Integer schemaVersion)

createdAt

public UserResponse.Builder createdAt(Optional<String> createdAt)

When the user was created, as an ISO-8601 UTC timestamp.

createdAt

public UserResponse.Builder createdAt(String createdAt)

externalSubject

public UserResponse.Builder externalSubject(Optional<String> externalSubject)

The user's identifier in your own authentication system (for example, a Cognito sub or Auth0 user ID). This is set when an invitation is accepted via PUT /v1/users/{id} with status=ACTIVE, and is null until the user is activated.

externalSubject

public UserResponse.Builder externalSubject(String externalSubject)

build

public UserResponse build()

additionalProperty

public UserResponse.Builder additionalProperty(String key,
 Object value)

additionalProperties

public UserResponse.Builder additionalProperties(Map<String,Object> additionalProperties)