Class: Orb::Models::AlertCreateForSubscriptionParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::AlertCreateForSubscriptionParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/alert_create_for_subscription_params.rb

Overview

See Also:

• Resources::Alerts#create_for_subscription

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #metric_id ⇒ String^?

  The metric to track usage for.

• #thresholds ⇒ Array<Orb::Models::Threshold>

  The thresholds that define the values at which the alert will be triggered.

• #type ⇒ Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type

  The type of alert to create.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(thresholds: , type: , metric_id: nil, request_options: {}) ⇒ Object constructor

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(thresholds: , type: , metric_id: nil, request_options: {}) ⇒ Object

Parameters:

• thresholds (Array<Orb::Models::Threshold>) (defaults to: ) —

  The thresholds that define the values at which the alert will be triggered.

• type (Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type) (defaults to: ) —

  The type of alert to create. This must be a valid alert type.

• metric_id (String, nil) (defaults to: nil) —

  The metric to track usage for.

• request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/orb/models/alert_create_for_subscription_params.rb', line 28

Instance Attribute Details

#metric_id ⇒ String^?

The metric to track usage for.

Returns:

• (String, nil)

# File 'lib/orb/models/alert_create_for_subscription_params.rb', line 26

optional :metric_id, String, nil?: true

#thresholds ⇒ Array<Orb::Models::Threshold>

The thresholds that define the values at which the alert will be triggered.

Returns:

• (Array<Orb::Models::Threshold>)

# File 'lib/orb/models/alert_create_for_subscription_params.rb', line 14

required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }

#type ⇒ Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type

The type of alert to create. This must be a valid alert type.

Returns:

• (Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type)

# File 'lib/orb/models/alert_create_for_subscription_params.rb', line 20

required :type, enum: -> { Orb::AlertCreateForSubscriptionParams::Type }