Class NamespaceRequest

java.lang.Object
ai.vectros.types.NamespaceRequest

public final class NamespaceRequest extends Object
  • Method Details

    • getNamespace

      public String getNamespace()
      Returns:
      The namespace to register: 2-32 characters, a lowercase letter first, then lowercase letters, digits, _ or -. The reserved names org and client are built in and cannot be registered, changed, or deleted. Required on registration; on update it must match the path and is otherwise ignored (the namespace is immutable).
    • getEntityBacked

      public Optional<Boolean> getEntityBacked()
      Returns:
      When true, every scope:<namespace> value in this namespace must resolve to an existing identity entity of the same account and namespace (create entities via POST /v1/entities/{namespace}), and the namespace gains the full identity-entity surface — list its entities, look them up by schema field, and filter other resources by them as a parent. When false (the default), values in this namespace are free-form strings validated by grammar only.
    • getDefaultSchemaId

      public Optional<String> getDefaultSchemaId()
      Returns:
      Optional ID of a record schema (created via POST /v1/schemas) bound as the default governing schema for entities created in this namespace. Must belong to your account.
    • getSpecificityRank

      public int getSpecificityRank()
      Returns:
      This namespace's position in your account's specificity order, used to break a tie when a caller holds two scope dimensions at once during recordType schema resolution — the higher-ranked (more specific) dimension's schema wins. Required on registration (no default); must be an integer between 0 and 1000000, unique across every namespace in your account, and not one of the two values reserved for the built-in namespaces (org=1000, client=2000). Optional on update — omit to leave it unchanged.
    • 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 NamespaceRequest.NamespaceStage builder()