Package ai.vectros.types

Class ClientRequest.Builder

java.lang.Object

ai.vectros.types.ClientRequest.Builder

All Implemented Interfaces:

ClientRequest._FinalStage, ClientRequest.ExternalIdStage

Enclosing class:

ClientRequest

public static final class ClientRequest.Builder
extends Object
implements ClientRequest.ExternalIdStage, ClientRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
ClientRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ClientRequest.Builder	additionalProperty(String key, Object value)
ClientRequest	build()
ClientRequest._FinalStage	externalId(@NotNull String externalId)	Your own unique identifier for this client.
ClientRequest.Builder	from(ClientRequest other)
ClientRequest._FinalStage	name(String name)	Display name for this client.
ClientRequest._FinalStage	name(Optional<String> name)	Display name for this client.
ClientRequest._FinalStage	orgId(String orgId)	The organization this client belongs to.
ClientRequest._FinalStage	orgId(Optional<String> orgId)	The organization this client belongs to.
ClientRequest._FinalStage	payload(Map<String,Object> payload)	Free-form key-value attributes to store with this client — handy for keeping extra data from your system without defining a schema.
ClientRequest._FinalStage	payload(Optional<Map<String,Object>> payload)	Free-form key-value attributes to store with this client — handy for keeping extra data from your system without defining a schema.
ClientRequest._FinalStage	schemaId(String schemaId)	Optional ID of a schema (created via POST /v1/schemas) that validates this client's payload and drives its lookup indexing.
ClientRequest._FinalStage	schemaId(Optional<String> schemaId)	Optional ID of a schema (created via POST /v1/schemas) that validates this client's payload and drives its lookup indexing.
ClientRequest._FinalStage	status(ClientRequestStatus status)	Lifecycle status of the client.
ClientRequest._FinalStage	status(Optional<ClientRequestStatus> status)	Lifecycle status of the client.

Methods inherited from class java.lang.Object

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

Method Details

from

public ClientRequest.Builder from(ClientRequest other)

Specified by:

from in interface ClientRequest.ExternalIdStage

externalId

public ClientRequest._FinalStage externalId(@NotNull
 @NotNull String externalId)

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.

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.

Specified by:

externalId in interface ClientRequest.ExternalIdStage

Returns:

Reference to this so that method calls can be chained together.

schemaId

public ClientRequest._FinalStage schemaId(String schemaId)

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.

Specified by:

schemaId in interface ClientRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

schemaId

public ClientRequest._FinalStage schemaId(Optional<String> schemaId)

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.

Specified by:

schemaId in interface ClientRequest._FinalStage

payload

public ClientRequest._FinalStage payload(Map<String,Object> payload)

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.

Specified by:

payload in interface ClientRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

payload

public ClientRequest._FinalStage payload(Optional<Map<String,Object>> payload)

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.

Specified by:

payload in interface ClientRequest._FinalStage

orgId

public ClientRequest._FinalStage orgId(String orgId)

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.

Specified by:

orgId in interface ClientRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

orgId

public ClientRequest._FinalStage orgId(Optional<String> orgId)

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.

Specified by:

orgId in interface ClientRequest._FinalStage

status

public ClientRequest._FinalStage status(ClientRequestStatus status)

Lifecycle status of the client. ACTIVE clients can be used normally; SUSPENDED clients are retained but blocked from new operations. Defaults to ACTIVE.

Specified by:

status in interface ClientRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

status

public ClientRequest._FinalStage status(Optional<ClientRequestStatus> status)

Lifecycle status of the client. ACTIVE clients can be used normally; SUSPENDED clients are retained but blocked from new operations. Defaults to ACTIVE.

Specified by:

status in interface ClientRequest._FinalStage

name

public ClientRequest._FinalStage name(String name)

Display name for this client.

Specified by:

name in interface ClientRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

name

public ClientRequest._FinalStage name(Optional<String> name)

Display name for this client.

Specified by:

name in interface ClientRequest._FinalStage

build

public ClientRequest build()

Specified by:

build in interface ClientRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface ClientRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface ClientRequest._FinalStage