Package ai.vectros.types

Interface FolderRequest._FinalStage

All Known Implementing Classes:
FolderRequest.Builder
Enclosing class:
FolderRequest
public static interface FolderRequest._FinalStage

  • Method Details

    • build

      FolderRequest build()

    • additionalProperty

      FolderRequest._FinalStage additionalProperty(String key, Object value)

    • additionalProperties

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

    • description

      FolderRequest._FinalStage description(Optional<String> description)

      Optional description of the folder's contents or purpose.

    • description

      FolderRequest._FinalStage description(String description)

    • parentFolderId

      FolderRequest._FinalStage parentFolderId(Optional<String> parentFolderId)

      ID of the parent folder to create this folder under, applied at creation only. Omit to create the folder under your context's default root folder. Ignored on update: a folder cannot currently be moved via the API.

    • parentFolderId

      FolderRequest._FinalStage parentFolderId(String parentFolderId)

    • slug

      FolderRequest._FinalStage slug(Optional<String> slug)

      Optional stable slug for the folder, unique among its siblings under the same parent. Useful as an idempotency key so re-creating the same folder returns the existing one rather than a duplicate. Derived from the name when omitted. Must be lowercase letters, digits, and hyphens. Immutable once the folder is created.

    • slug

      FolderRequest._FinalStage slug(String slug)

    • userId

      FolderRequest._FinalStage userId(Optional<String> userId)

      Optional ID of the user that should own this folder — the Vectros-assigned UUID of a user in your account. With an API key, this sets the folder's owner directly. With a scoped token, it must match the token's identity claim (if one is set) or fall within the token's data scope.

    • userId

      FolderRequest._FinalStage userId(String userId)

    • orgId

      FolderRequest._FinalStage orgId(Optional<String> orgId)

      Optional ID of the organization that should own this folder — the Vectros-assigned UUID of an organization in your account. With an API key, this sets the owning organization directly. With a scoped token, it must match the token's identity claim (if one is set) or fall within the token's data scope.

    • orgId

      FolderRequest._FinalStage orgId(String orgId)

    • clientId

      FolderRequest._FinalStage clientId(Optional<String> clientId)

      Optional ID of the client to associate with this folder — the Vectros-assigned UUID of a client in your account. With an API key, this sets the client directly. With a scoped token, it must match the token's identity claim (if one is set) or fall within the token's data scope.

    • clientId

      FolderRequest._FinalStage clientId(String clientId)

    • expectedVersion

      FolderRequest._FinalStage expectedVersion(Optional<Long> expectedVersion)

      Optimistic-concurrency token for updates. Pass the version you last read to make the update conditional — it is rejected with a 409 version conflict (and the stored folder is left untouched) if the folder changed since. Omit for last-write-wins (the default). Ignored on create.

    • expectedVersion

      FolderRequest._FinalStage expectedVersion(Long expectedVersion)