Package ai.vectros.types

Class NamespaceRequest.Builder

java.lang.Object
ai.vectros.types.NamespaceRequest.Builder
All Implemented Interfaces:
NamespaceRequest._FinalStage, NamespaceRequest.NamespaceStage, NamespaceRequest.SpecificityRankStage
Enclosing class:
NamespaceRequest
public static final class NamespaceRequest.Builder extends Object implements NamespaceRequest.NamespaceStage, NamespaceRequest.SpecificityRankStage, NamespaceRequest._FinalStage

  • Method Details

    • from

      public NamespaceRequest.Builder from(NamespaceRequest other)
      Specified by:
      from in interface NamespaceRequest.NamespaceStage

    • namespace

      public NamespaceRequest.SpecificityRankStage namespace(@NotNull @NotNull String namespace)

      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).

      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).

      Specified by:
      namespace in interface NamespaceRequest.NamespaceStage
      Returns:
      Reference to this so that method calls can be chained together.

    • specificityRank

      public NamespaceRequest._FinalStage specificityRank(int specificityRank)

      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.

      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.

      Specified by:
      specificityRank in interface NamespaceRequest.SpecificityRankStage
      Returns:
      Reference to this so that method calls can be chained together.

    • defaultSchemaId

      public NamespaceRequest._FinalStage defaultSchemaId(String defaultSchemaId)

      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.

      Specified by:
      defaultSchemaId in interface NamespaceRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • defaultSchemaId

      public NamespaceRequest._FinalStage defaultSchemaId(Optional<String> defaultSchemaId)

      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.

      Specified by:
      defaultSchemaId in interface NamespaceRequest._FinalStage

    • entityBacked

      public NamespaceRequest._FinalStage entityBacked(Boolean entityBacked)

      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.

      Specified by:
      entityBacked in interface NamespaceRequest._FinalStage
      Returns:
      Reference to this so that method calls can be chained together.

    • entityBacked

      public NamespaceRequest._FinalStage entityBacked(Optional<Boolean> entityBacked)

      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.

      Specified by:
      entityBacked in interface NamespaceRequest._FinalStage

    • build

      public NamespaceRequest build()
      Specified by:
      build in interface NamespaceRequest._FinalStage

    • additionalProperty

      public NamespaceRequest.Builder additionalProperty(String key, Object value)
      Specified by:
      additionalProperty in interface NamespaceRequest._FinalStage

    • additionalProperties

      public NamespaceRequest.Builder additionalProperties(Map<String,Object> additionalProperties)
      Specified by:
      additionalProperties in interface NamespaceRequest._FinalStage