Package ai.vectros.types

Class FolderResponse

java.lang.Object
ai.vectros.types.FolderResponse
public final class FolderResponse extends Object

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      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.

    • getId

      public Optional<String> getId()
      Returns:
      Unique identifier for the folder, assigned by Vectros.

    • getName

      public Optional<String> getName()
      Returns:
      Human-readable display name of the folder.

    • getDescription

      public Optional<String> getDescription()
      Returns:
      Optional description of the folder's contents or purpose.

    • getParentFolderId

      public Optional<String> getParentFolderId()
      Returns:
      ID of this folder's parent. Null when the folder is a root folder.

    • getSlug

      public Optional<String> getSlug()
      Returns:
      Stable URL-safe slug for the folder, unique among its siblings under the same parent. Assigned at creation and immutable thereafter.

    • getDepth

      public Optional<Integer> getDepth()
      Returns:
      How deeply the folder is nested. A root folder has depth 0; each level below increments by 1.

    • getIsProtected

      public Optional<Boolean> getIsProtected()
      Returns:
      Whether this folder is protected from deletion. Your context's root folder is protected.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      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.

    • getScopes

      public Optional<List<String>> getScopes()
      Returns:
      The folder's scope ownership as canonical namespace:value entries (at most 2). org and client are built-in namespaces; any other is a custom scope you define. Set at creation, either explicitly or automatically from the calling token's identity. Empty for a folder owned by a user alone (or unowned).

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the folder was created, as an ISO-8601 UTC timestamp.

    • getLastModified

      public Optional<String> getLastModified()
      Returns:
      When the folder was last modified, as an ISO-8601 UTC timestamp.

    • getVersion

      public Optional<Long> getVersion()
      Returns:
      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.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static FolderResponse.Builder builder()