Class: Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Data, Pagination

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(cadence:, current_usage:, entity_id:, entity_type:, parent_id:, scope_entity_ids:, usage_limit:, usage_period_end:, usage_period_start:, utilization:, currency_id: nil, feature_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Data for more details.

A node of the governance hierarchy tree with its usage configuration (limit, cadence, scope) and current usage. Usage is read from a periodically-refreshed read model and may lag the live counter by a short interval; it never gates access.

Parameters:

  • cadence (String, nil) —

    Usage-reset cadence as an ISO-8601 single-unit duration, e.g. ‘P1M`, `P30D`, `PT

  • current_usage (Float, nil) —

    Usage consumed in the current cadence period (may lag the live counter by a shor

  • entity_id (String) —

    External id of the entity at this node.

  • entity_type (String) —

    External id of the entity type (e.g. ‘team`, `user`).

  • parent_id (String, nil) —

    External id of the parent entity in the tree; ‘null` for a root. Use it to rebui

  • scope_entity_ids (Array<String>) —

    The configuration scope (entity ids). Empty is the node-wide configuration; a no

  • usage_limit (Float, nil) —

    Hard usage limit for this node per cadence period.

  • usage_period_end (Time, nil) —

    Exclusive end of the cadence period — when usage resets; ‘null` once the period

  • usage_period_start (Time, nil) —

    Start of the cadence period the usage snapshot belongs to; ‘null` once the perio

  • utilization (Float, nil) —

    ‘currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The cros

  • currency_id (String) (defaults to: nil) —

    The metered currency refId (present when the configured capability is a credit c

  • feature_id (String) (defaults to: nil) —

    The metered feature refId (present when the configured capability is a feature).




# File 'lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb', line 110

Instance Attribute Details

#data ⇒ Array<Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data>

Returns:



13
14
 
# File 'lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb', line 13

required :data,
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data] }

#pagination ⇒ Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination

Returns:



19
20
 
# File 'lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb', line 19

required :pagination,
-> { Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination }