Package ai.vectros.types

Class FolderResponse.Builder

java.lang.Object

ai.vectros.types.FolderResponse.Builder

Enclosing class:

FolderResponse

public static final class FolderResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
FolderResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
FolderResponse.Builder	additionalProperty(String key, Object value)
FolderResponse	build()
FolderResponse.Builder	created(Boolean created)
FolderResponse.Builder	created(Optional<Boolean> created)	Present only on a create response: true when a new folder was created (HTTP 201), false when a folder with the same slug already existed under the same parent and was returned instead (HTTP 200).
FolderResponse.Builder	createdAt(String createdAt)
FolderResponse.Builder	createdAt(Optional<String> createdAt)	When the folder was created, as an ISO-8601 UTC timestamp.
FolderResponse.Builder	depth(Integer depth)
FolderResponse.Builder	depth(Optional<Integer> depth)	How deeply the folder is nested.
FolderResponse.Builder	description(String description)
FolderResponse.Builder	description(Optional<String> description)	Optional description of the folder's contents or purpose.
FolderResponse.Builder	from(FolderResponse other)
FolderResponse.Builder	id(String id)
FolderResponse.Builder	id(Optional<String> id)	Unique identifier for the folder, assigned by Vectros.
FolderResponse.Builder	isProtected(Boolean isProtected)
FolderResponse.Builder	isProtected(Optional<Boolean> isProtected)	Whether this folder is protected from deletion.
FolderResponse.Builder	lastModified(String lastModified)
FolderResponse.Builder	lastModified(Optional<String> lastModified)	When the folder was last modified, as an ISO-8601 UTC timestamp.
FolderResponse.Builder	name(String name)
FolderResponse.Builder	name(Optional<String> name)	Human-readable display name of the folder.
FolderResponse.Builder	parentFolderId(String parentFolderId)
FolderResponse.Builder	parentFolderId(Optional<String> parentFolderId)	ID of this folder's parent.
FolderResponse.Builder	scopes(List<String> scopes)
FolderResponse.Builder	scopes(Optional<List<String>> scopes)	The folder's scope ownership as canonical namespace:value entries (at most 2).
FolderResponse.Builder	slug(String slug)
FolderResponse.Builder	slug(Optional<String> slug)	Stable URL-safe slug for the folder, unique among its siblings under the same parent.
FolderResponse.Builder	userId(String userId)
FolderResponse.Builder	userId(Optional<String> userId)	ID of the user that owns this folder — the Vectros-assigned UUID of a user in your account.
FolderResponse.Builder	version(Long version)
FolderResponse.Builder	version(Optional<Long> version)	Optimistic-concurrency version, incremented on every successful write.

Methods inherited from class java.lang.Object

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

Method Details

from

public FolderResponse.Builder from(FolderResponse other)

created

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

Present only on a create response: true when a new folder was created (HTTP 201), false when a folder with the same slug already existed under the same parent and was returned instead (HTTP 200). Omitted on reads, lists, and updates.

created

public FolderResponse.Builder created(Boolean created)

id

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

Unique identifier for the folder, assigned by Vectros.

id

public FolderResponse.Builder id(String id)

name

public FolderResponse.Builder name(Optional<String> name)

Human-readable display name of the folder.

name

public FolderResponse.Builder name(String name)

description

public FolderResponse.Builder description(Optional<String> description)

Optional description of the folder's contents or purpose.

description

public FolderResponse.Builder description(String description)

parentFolderId

public FolderResponse.Builder parentFolderId(Optional<String> parentFolderId)

ID of this folder's parent. Null when the folder is a root folder.

parentFolderId

public FolderResponse.Builder parentFolderId(String parentFolderId)

slug

public FolderResponse.Builder slug(Optional<String> slug)

Stable URL-safe slug for the folder, unique among its siblings under the same parent. Assigned at creation and immutable thereafter.

slug

public FolderResponse.Builder slug(String slug)

depth

public FolderResponse.Builder depth(Optional<Integer> depth)

How deeply the folder is nested. A root folder has depth 0; each level below increments by 1.

depth

public FolderResponse.Builder depth(Integer depth)

isProtected

public FolderResponse.Builder isProtected(Optional<Boolean> isProtected)

Whether this folder is protected from deletion. Your context's root folder is protected.

isProtected

public FolderResponse.Builder isProtected(Boolean isProtected)

userId

public FolderResponse.Builder userId(Optional<String> userId)

ID of the user that owns this folder — the Vectros-assigned UUID of a user in your account. Null if the folder is not owned by a specific user.

userId

public FolderResponse.Builder userId(String userId)

scopes

public FolderResponse.Builder scopes(Optional<List<String>> scopes)

The folder's scope ownership as canonical namespace:value entries (at most 2). org and client are reserved namespace names; any other is one you registered yourself. Set at creation, either explicitly or automatically from the calling token's identity. Empty for a folder owned by a user alone (or unowned).

scopes

public FolderResponse.Builder scopes(List<String> scopes)

createdAt

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

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

createdAt

public FolderResponse.Builder createdAt(String createdAt)

lastModified

public FolderResponse.Builder lastModified(Optional<String> lastModified)

When the folder was last modified, as an ISO-8601 UTC timestamp.

lastModified

public FolderResponse.Builder lastModified(String lastModified)

version

public FolderResponse.Builder version(Optional<Long> version)

Optimistic-concurrency version, incremented on every successful write. Pass it back as expectedVersion on a later update or patch to avoid silently overwriting a concurrent change — the write is rejected with a 409 version conflict if the folder has changed since.

version

public FolderResponse.Builder version(Long version)

build

public FolderResponse build()

additionalProperty

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

additionalProperties

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