Package ai.vectros.types

Class AppContextRequest.Builder

java.lang.Object

ai.vectros.types.AppContextRequest.Builder

All Implemented Interfaces:

AppContextRequest._FinalStage, AppContextRequest.ContextIdStage, AppContextRequest.NameStage

Enclosing class:

AppContextRequest

public static final class AppContextRequest.Builder
extends Object
implements AppContextRequest.ContextIdStage, AppContextRequest.NameStage, AppContextRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
AppContextRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
AppContextRequest.Builder	additionalProperty(String key, Object value)
AppContextRequest	build()
AppContextRequest._FinalStage	companyName(String companyName)	Optional display name for the organization deploying this app context — distinct from name, which is the app's own identity.
AppContextRequest._FinalStage	companyName(Optional<String> companyName)	Optional display name for the organization deploying this app context — distinct from name, which is the app's own identity.
AppContextRequest.NameStage	contextId(@NotNull String contextId)	Your identifier for the app context.
AppContextRequest._FinalStage	description(String description)	Optional free-text description of what this app context is for.
AppContextRequest._FinalStage	description(Optional<String> description)	Optional free-text description of what this app context is for.
AppContextRequest.Builder	from(AppContextRequest other)
AppContextRequest._FinalStage	meteringAxis(String meteringAxis)	Declares the per-principal metering axis for this app context — enables visibility into and (with principalUsageCap) enforcement of per-principal usage within this context.
AppContextRequest._FinalStage	meteringAxis(Optional<String> meteringAxis)	Declares the per-principal metering axis for this app context — enables visibility into and (with principalUsageCap) enforcement of per-principal usage within this context.
AppContextRequest._FinalStage	name(@NotNull String name)	Human-readable display name for this app context.
AppContextRequest._FinalStage	principalBurstLimit(Integer principalBurstLimit)	Per-principal, per-minute request cap, for the opt-in per-principal burst-protection feature.
AppContextRequest._FinalStage	principalBurstLimit(Optional<Integer> principalBurstLimit)	Per-principal, per-minute request cap, for the opt-in per-principal burst-protection feature.
AppContextRequest._FinalStage	principalUsageCap(Integer principalUsageCap)	Per-principal, per-billing-period operation cap, for the opt-in per-principal usage/quota feature.
AppContextRequest._FinalStage	principalUsageCap(Optional<Integer> principalUsageCap)	Per-principal, per-billing-period operation cap, for the opt-in per-principal usage/quota feature.

Methods inherited from class java.lang.Object

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

Method Details

from

public AppContextRequest.Builder from(AppContextRequest other)

Specified by:

from in interface AppContextRequest.ContextIdStage

contextId

public AppContextRequest.NameStage contextId(@NotNull
 @NotNull String contextId)

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.

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.

Specified by:

contextId in interface AppContextRequest.ContextIdStage

Returns:

Reference to this so that method calls can be chained together.

name

public AppContextRequest._FinalStage name(@NotNull
 @NotNull String name)

Human-readable display name for this app context. Required.

Human-readable display name for this app context. Required.

Specified by:

name in interface AppContextRequest.NameStage

Returns:

Reference to this so that method calls can be chained together.

principalUsageCap

public AppContextRequest._FinalStage principalUsageCap(Integer principalUsageCap)

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.

Specified by:

principalUsageCap in interface AppContextRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

principalUsageCap

public AppContextRequest._FinalStage principalUsageCap(Optional<Integer> principalUsageCap)

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.

Specified by:

principalUsageCap in interface AppContextRequest._FinalStage

principalBurstLimit

public AppContextRequest._FinalStage principalBurstLimit(Integer principalBurstLimit)

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.

Specified by:

principalBurstLimit in interface AppContextRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

principalBurstLimit

public AppContextRequest._FinalStage principalBurstLimit(Optional<Integer> principalBurstLimit)

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.

Specified by:

principalBurstLimit in interface AppContextRequest._FinalStage

meteringAxis

public AppContextRequest._FinalStage meteringAxis(String meteringAxis)

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.

Specified by:

meteringAxis in interface AppContextRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

meteringAxis

public AppContextRequest._FinalStage meteringAxis(Optional<String> meteringAxis)

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.

Specified by:

meteringAxis in interface AppContextRequest._FinalStage

companyName

public AppContextRequest._FinalStage companyName(String companyName)

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.

Specified by:

companyName in interface AppContextRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

companyName

public AppContextRequest._FinalStage companyName(Optional<String> companyName)

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.

Specified by:

companyName in interface AppContextRequest._FinalStage

description

public AppContextRequest._FinalStage description(String description)

Optional free-text description of what this app context is for.

Specified by:

description in interface AppContextRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

description

public AppContextRequest._FinalStage description(Optional<String> description)

Optional free-text description of what this app context is for.

Specified by:

description in interface AppContextRequest._FinalStage

build

public AppContextRequest build()

Specified by:

build in interface AppContextRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface AppContextRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface AppContextRequest._FinalStage