Class: MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Dashboard Classes: BmGroupKeyOverride, ColorOverride, DashboardOption

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(group_key_name: , display_name: nil, value_display_names: nil) ⇒ Object

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

Parameters:

  • group_key_name (String) (defaults to: ) —

    The name of the billable metric group key.

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

    The display name for the billable metric group key

  • value_display_names (Hash{Symbol=>Object}) (defaults to: nil) —

    <key, value> pairs of the billable metric group key values and their display nam




# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 43

Instance Attribute Details

#bm_group_key_overrides ⇒ Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>?

Optional list of billable metric group key overrides

Returns:



26
27
 
# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 26

optional :bm_group_key_overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride] }

#color_overrides ⇒ Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>?

Optional list of colors to override

Returns:



33
34
 
# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 33

optional :color_overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride] }

#customer_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 14

required :customer_id, String

#dashboard ⇒ Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard

The type of dashboard to retrieve.

Returns:



20
 
# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 20

required :dashboard, enum: -> { MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard }

#dashboard_options ⇒ Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>?

Optional dashboard specific options

Returns:



40
41
 
# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 40

optional :dashboard_options,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb', line 65