Files
sdk/docs/GatewayPolicy.md

11 KiB

GatewayPolicy

Properties

Name Type Description Notes
CachePaths Pointer to map[string]int64 CachePaths overrides CacheTTLSec per path PREFIX (key "/v1/models" → seconds). The longest matching prefix wins. [optional]
CacheTtlSec Pointer to int64 CacheTTLSec is the org's default edge-cache TTL for its responses, in seconds; 0 means no caching. Unset inherits the platform default. [optional]
CorsOrigins Pointer to []string CORSOrigins is the PLATFORM-scope CORS allowlist EdgeCORS admits: an exact origin, a bare host, or a "*.host" wildcard. Writable only by a SuperAdmin — CORS is evaluated before identity, so it has no tenant to scope to. [optional]
Methods Pointer to []string Methods is the allowlist of HTTP methods the edge accepts for this org. Empty means all are accepted. [optional]
Mode Pointer to string Mode is the abuse gate's posture for THIS scope: "shadow" scores traffic and records the verdict without acting on it, "live" enforces it. Unset means shadow. It is the one per-org field that does NOT inherit. Every other field here layers a platform default under the org's own value, which is right for a default: a tenant that sets no rate ceiling should get the platform's. Mode is not a default, it is an ARMING DECISION — it is what makes a statistical judgement start refusing real traffic — and inheriting it means arming one scope arms every tenant that never asked for it, without a write to their row and without anything in their config changing. So a tenant is live only if that tenant's OWN row says live, and the platform row's mode governs exactly one scope: the anonymous lane, which has no tenant of its own. It is also not self-service. Writing it requires SuperAdmin (see the /v1/gateway config op): the subject of an abuse control does not get to switch the control off. [optional]
OrgCap Pointer to int64 OrgCap is the most this organization's ceiling may be, requests per minute. Unset, it is the platform's org_rpm, else 60,000. Only a SuperAdmin sets it: it is how the platform raises one organization above the default, and the organization a limit governs does not get to remove it. It does not inherit from the platform row. Read back, it is the cap in force. [optional]
OrgRpm Pointer to int64 OrgRPM is the org's OWN authenticated rate ceiling, requests per minute, as ScopeRateLimit enforces it across the deployment. An organization may lower it but never raise it past its cap (org_cap); unset, the org is held to its cap. On the platform row it is every organization's default cap, and it does not inherit into any organization's own row. Read back, it is the ceiling in force: the org's own, clipped to its cap. [optional]
PerIpRpm Pointer to int64 PerIPRPM is the PLATFORM-scope flood cap: requests admitted per WindowSec from one client IP that presents no credential, or a credential that resolves to nobody. A request presenting a credential is held to ten times this from its address until the credential is checked; a validated caller is then held by its key and org ceilings instead. SuperAdmin-only, same reason. [optional]
UpdatedAt Pointer to int64 UpdatedAt is the unix second this policy row was last written. Server-stamped; a client-supplied value is ignored. [optional]
UpdatedBy Pointer to string UpdatedBy is the validated user id that wrote this policy row. Server-stamped; a client-supplied value is ignored. [optional]
WindowSec Pointer to int64 WindowSec is the window PerIPRPM is counted over, in seconds. SuperAdmin-only. [optional]

Methods

NewGatewayPolicy

func NewGatewayPolicy() *GatewayPolicy

NewGatewayPolicy instantiates a new GatewayPolicy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewGatewayPolicyWithDefaults

func NewGatewayPolicyWithDefaults() *GatewayPolicy

NewGatewayPolicyWithDefaults instantiates a new GatewayPolicy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetCachePaths

func (o *GatewayPolicy) GetCachePaths() map[string]int64

GetCachePaths returns the CachePaths field if non-nil, zero value otherwise.

GetCachePathsOk

func (o *GatewayPolicy) GetCachePathsOk() (*map[string]int64, bool)

GetCachePathsOk returns a tuple with the CachePaths field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCachePaths

func (o *GatewayPolicy) SetCachePaths(v map[string]int64)

SetCachePaths sets CachePaths field to given value.

HasCachePaths

func (o *GatewayPolicy) HasCachePaths() bool

HasCachePaths returns a boolean if a field has been set.

GetCacheTtlSec

func (o *GatewayPolicy) GetCacheTtlSec() int64

GetCacheTtlSec returns the CacheTtlSec field if non-nil, zero value otherwise.

GetCacheTtlSecOk

func (o *GatewayPolicy) GetCacheTtlSecOk() (*int64, bool)

GetCacheTtlSecOk returns a tuple with the CacheTtlSec field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCacheTtlSec

func (o *GatewayPolicy) SetCacheTtlSec(v int64)

SetCacheTtlSec sets CacheTtlSec field to given value.

HasCacheTtlSec

func (o *GatewayPolicy) HasCacheTtlSec() bool

HasCacheTtlSec returns a boolean if a field has been set.

GetCorsOrigins

func (o *GatewayPolicy) GetCorsOrigins() []string

GetCorsOrigins returns the CorsOrigins field if non-nil, zero value otherwise.

GetCorsOriginsOk

func (o *GatewayPolicy) GetCorsOriginsOk() (*[]string, bool)

GetCorsOriginsOk returns a tuple with the CorsOrigins field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCorsOrigins

func (o *GatewayPolicy) SetCorsOrigins(v []string)

SetCorsOrigins sets CorsOrigins field to given value.

HasCorsOrigins

func (o *GatewayPolicy) HasCorsOrigins() bool

HasCorsOrigins returns a boolean if a field has been set.

GetMethods

func (o *GatewayPolicy) GetMethods() []string

GetMethods returns the Methods field if non-nil, zero value otherwise.

GetMethodsOk

func (o *GatewayPolicy) GetMethodsOk() (*[]string, bool)

GetMethodsOk returns a tuple with the Methods field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMethods

func (o *GatewayPolicy) SetMethods(v []string)

SetMethods sets Methods field to given value.

HasMethods

func (o *GatewayPolicy) HasMethods() bool

HasMethods returns a boolean if a field has been set.

GetMode

func (o *GatewayPolicy) GetMode() string

GetMode returns the Mode field if non-nil, zero value otherwise.

GetModeOk

func (o *GatewayPolicy) GetModeOk() (*string, bool)

GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMode

func (o *GatewayPolicy) SetMode(v string)

SetMode sets Mode field to given value.

HasMode

func (o *GatewayPolicy) HasMode() bool

HasMode returns a boolean if a field has been set.

GetOrgCap

func (o *GatewayPolicy) GetOrgCap() int64

GetOrgCap returns the OrgCap field if non-nil, zero value otherwise.

GetOrgCapOk

func (o *GatewayPolicy) GetOrgCapOk() (*int64, bool)

GetOrgCapOk returns a tuple with the OrgCap field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOrgCap

func (o *GatewayPolicy) SetOrgCap(v int64)

SetOrgCap sets OrgCap field to given value.

HasOrgCap

func (o *GatewayPolicy) HasOrgCap() bool

HasOrgCap returns a boolean if a field has been set.

GetOrgRpm

func (o *GatewayPolicy) GetOrgRpm() int64

GetOrgRpm returns the OrgRpm field if non-nil, zero value otherwise.

GetOrgRpmOk

func (o *GatewayPolicy) GetOrgRpmOk() (*int64, bool)

GetOrgRpmOk returns a tuple with the OrgRpm field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOrgRpm

func (o *GatewayPolicy) SetOrgRpm(v int64)

SetOrgRpm sets OrgRpm field to given value.

HasOrgRpm

func (o *GatewayPolicy) HasOrgRpm() bool

HasOrgRpm returns a boolean if a field has been set.

GetPerIpRpm

func (o *GatewayPolicy) GetPerIpRpm() int64

GetPerIpRpm returns the PerIpRpm field if non-nil, zero value otherwise.

GetPerIpRpmOk

func (o *GatewayPolicy) GetPerIpRpmOk() (*int64, bool)

GetPerIpRpmOk returns a tuple with the PerIpRpm field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPerIpRpm

func (o *GatewayPolicy) SetPerIpRpm(v int64)

SetPerIpRpm sets PerIpRpm field to given value.

HasPerIpRpm

func (o *GatewayPolicy) HasPerIpRpm() bool

HasPerIpRpm returns a boolean if a field has been set.

GetUpdatedAt

func (o *GatewayPolicy) GetUpdatedAt() int64

GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.

GetUpdatedAtOk

func (o *GatewayPolicy) GetUpdatedAtOk() (*int64, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUpdatedAt

func (o *GatewayPolicy) SetUpdatedAt(v int64)

SetUpdatedAt sets UpdatedAt field to given value.

HasUpdatedAt

func (o *GatewayPolicy) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

GetUpdatedBy

func (o *GatewayPolicy) GetUpdatedBy() string

GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise.

GetUpdatedByOk

func (o *GatewayPolicy) GetUpdatedByOk() (*string, bool)

GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUpdatedBy

func (o *GatewayPolicy) SetUpdatedBy(v string)

SetUpdatedBy sets UpdatedBy field to given value.

HasUpdatedBy

func (o *GatewayPolicy) HasUpdatedBy() bool

HasUpdatedBy returns a boolean if a field has been set.

GetWindowSec

func (o *GatewayPolicy) GetWindowSec() int64

GetWindowSec returns the WindowSec field if non-nil, zero value otherwise.

GetWindowSecOk

func (o *GatewayPolicy) GetWindowSecOk() (*int64, bool)

GetWindowSecOk returns a tuple with the WindowSec field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetWindowSec

func (o *GatewayPolicy) SetWindowSec(v int64)

SetWindowSec sets WindowSec field to given value.

HasWindowSec

func (o *GatewayPolicy) HasWindowSec() bool

HasWindowSec returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]