Package ai.vectros.types

Interface ClientRequest._FinalStage

All Known Implementing Classes:

ClientRequest.Builder

Enclosing class:

ClientRequest

public static interface ClientRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
ClientRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
ClientRequest._FinalStage	additionalProperty(String key, Object value)
ClientRequest	build()
ClientRequest._FinalStage	name(String name)
ClientRequest._FinalStage	name(Optional<String> name)	Display name for this client.
ClientRequest._FinalStage	orgId(String orgId)
ClientRequest._FinalStage	orgId(Optional<String> orgId)	The organization this client belongs to.
ClientRequest._FinalStage	payload(Map<String,Object> payload)
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)
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)
ClientRequest._FinalStage	status(Optional<ClientRequestStatus> status)	Lifecycle status of the client.

Method Details

build

ClientRequest build()

additionalProperty

ClientRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

ClientRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

name

ClientRequest._FinalStage name(Optional<String> name)

Display name for this client.

name

ClientRequest._FinalStage name(String name)

status

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.

status

ClientRequest._FinalStage status(ClientRequestStatus status)

orgId

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.

orgId

ClientRequest._FinalStage orgId(String orgId)

payload

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.

payload

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

schemaId

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.

schemaId

ClientRequest._FinalStage schemaId(String schemaId)