Class: Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Chain

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1_beta/customers/entitlement_check_response.rb

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(current_usage:, entity_id:, is_granted:, scope_entity_ids:, usage_limit:) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1Beta::Customers::EntitlementCheckResponse::Data::Credit::Chain for more details.

Per-entity governance node — limit and current usage for a single resolved entity.

Parameters:

  • current_usage (Float) —

    Amount consumed by this entity in the current cadence period.

  • entity_id (String) —

    External id of the entity within the customer.

  • is_granted (Boolean) —

    Whether this node alone permits the requested usage.

  • scope_entity_ids (Array<String>) —

    External ids of the entities this budget is scoped to. Empty (‘[]`) is the node-

  • usage_limit (Float, nil) —

    Hard usage limit for this node; null when no assignment is configured.




# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 531

Instance Attribute Details

#current_usage ⇒ Float

Amount consumed by this entity in the current cadence period.

Returns:

  • (Float) 


503
 
# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 503

required :current_usage, Float, api_name: :currentUsage

#entity_id ⇒ String

External id of the entity within the customer.

Returns:

  • (String) 


509
 
# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 509

required :entity_id, String, api_name: :entityId

#is_granted ⇒ Boolean

Whether this node alone permits the requested usage.

Returns:

  • (Boolean) 


515
 
# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 515

required :is_granted, Stigg::Internal::Type::Boolean, api_name: :isGranted

#scope_entity_ids ⇒ Array<String>

External ids of the entities this budget is scoped to. Empty (‘[]`) is the node-wide budget; a non-empty set is the dimension-scoped budget that matched this request — use it to tell apart multiple budgets on the same entity.

Returns:

  • (Array<String>) 


523
 
# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 523

required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds

#usage_limit ⇒ Float?

Hard usage limit for this node; null when no assignment is configured.

Returns:

  • (Float, nil) 


529
 
# File 'lib/stigg/models/v1_beta/customers/entitlement_check_response.rb', line 529

required :usage_limit, Float, api_name: :usageLimit, nil?: true