Package ai.vectros.types

Class AppContextRequest

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

  • Method Details

    • getContextId

      public String getContextId()
      Returns:
      Your identifier for the app context. Must be 3-31 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens (for example myapp, taskflow, or engineering-team). Required when creating a context. Ignored when updating, since the URL path supplies the contextId on update.

    • getName

      public String getName()
      Returns:
      Human-readable display name for this app context. Required.

    • getDescription

      public Optional<String> getDescription()
      Returns:
      Optional free-text description of what this app context is for.

    • getCompanyName

      public Optional<String> getCompanyName()
      Returns:
      Optional display name for the organization deploying this app context — distinct from name, which is the app's own identity. Used to personalize platform-sent correspondence (e.g. sub-user invitation emails) with your own branding instead of a generic app name.

    • getMeteringAxis

      public Optional<String> getMeteringAxis()
      Returns:
      Declares the per-principal metering axis for this app context — enables visibility into and (with principalUsageCap) enforcement of per-principal usage within this context. Either user (per end-user) or scope:<namespace> (per declared namespace, e.g. scope:org). Omit to leave context-only accounting unchanged (the default). Only takes effect for a partner with the corresponding account-level feature enabled.

    • getPrincipalBurstLimit

      public Optional<Integer> getPrincipalBurstLimit()
      Returns:
      Per-principal, per-minute request cap, for the opt-in per-principal burst-protection feature. Only takes effect for a partner with that feature enabled on their account. Omit to leave unset.

    • getPrincipalUsageCap

      public Optional<Integer> getPrincipalUsageCap()
      Returns:
      Per-principal, per-billing-period operation cap, for the opt-in per-principal usage/quota feature. Omit to track per-principal usage without enforcing a cap. Only takes effect for a partner with that feature enabled on their account.

    • 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 AppContextRequest.ContextIdStage builder()