Interface AppContextRequest._FinalStage
- All Known Implementing Classes:
AppContextRequest.Builder
- Enclosing class:
AppContextRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()companyName(String companyName) companyName(Optional<String> companyName) Optional display name for the organization deploying this app context — distinct fromname, which is the app's own identity.description(String description) description(Optional<String> description) Optional free-text description of what this app context is for.meteringAxis(String meteringAxis) meteringAxis(Optional<String> meteringAxis) Declares the per-principal metering axis for this app context — enables visibility into and (withprincipalUsageCap) enforcement of per-principal usage within this context.principalBurstLimit(Integer principalBurstLimit) principalBurstLimit(Optional<Integer> principalBurstLimit) Per-principal, per-minute request cap, for the opt-in per-principal burst-protection feature.principalUsageCap(Integer principalUsageCap) principalUsageCap(Optional<Integer> principalUsageCap) Per-principal, per-billing-period operation cap, for the opt-in per-principal usage/quota feature.
-
Method Details
-
build
AppContextRequest build() -
additionalProperty
-
additionalProperties
-
description
Optional free-text description of what this app context is for.
-
description
-
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. -
companyName
-
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. Eitheruser(per end-user) orscope:<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. -
meteringAxis
-
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.
-
principalBurstLimit
-
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.
-
principalUsageCap
-