Class: Orb::Models::DimensionalPriceGroup

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/dimensional_price_group.rb

Overview

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(id: , billable_metric_id: , dimensions: , external_dimensional_price_group_id: , metadata: , name: ) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::DimensionalPriceGroup for more details.

A dimensional price group is used to partition the result of a billable metric by a set of dimensions. Prices in a price group must specify the parition used to derive their usage.

Parameters:

  • id (String) (defaults to: )
  • billable_metric_id (String) (defaults to: )

    The billable metric associated with this dimensional price group. All prices ass

  • dimensions (Array<String>) (defaults to: )

    The dimensions that this dimensional price group is defined over

  • external_dimensional_price_group_id (String, nil) (defaults to: )

    An alias for the dimensional price group

  • metadata (Hash{Symbol=>String}) (defaults to: )

    User specified key-value pairs for the resource. If not present, this defaults t

  • name (String) (defaults to: )

    The name of the dimensional price group



# File 'lib/orb/models/dimensional_price_group.rb', line 47

Instance Attribute Details

#billable_metric_idString

The billable metric associated with this dimensional price group. All prices associated with this dimensional price group will be computed using this billable metric.

Returns:

  • (String)


18
# File 'lib/orb/models/dimensional_price_group.rb', line 18

required :billable_metric_id, String

#dimensionsArray<String>

The dimensions that this dimensional price group is defined over

Returns:

  • (Array<String>)


24
# File 'lib/orb/models/dimensional_price_group.rb', line 24

required :dimensions, Orb::Internal::Type::ArrayOf[String]

#external_dimensional_price_group_idString?

An alias for the dimensional price group

Returns:

  • (String, nil)


30
# File 'lib/orb/models/dimensional_price_group.rb', line 30

required :external_dimensional_price_group_id, String, nil?: true

#idString

Returns:

  • (String)


10
# File 'lib/orb/models/dimensional_price_group.rb', line 10

required :id, String

#metadataHash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to ‘null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.

Returns:

  • (Hash{Symbol=>String})


39
# File 'lib/orb/models/dimensional_price_group.rb', line 39

required :metadata, Orb::Internal::Type::HashOf[String]

#nameString

The name of the dimensional price group

Returns:

  • (String)


45
# File 'lib/orb/models/dimensional_price_group.rb', line 45

required :name, String