Class: MetronomeSDK::Models::PropertyFilter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/property_filter.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(name: , exists: nil, in_values: nil, not_in_values: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::PropertyFilter for more details.

Parameters:

  • name (String) (defaults to: ) —

    The name of the event property.

  • exists (Boolean) (defaults to: nil) —

    Determines whether the property must exist in the event. If true, only events wi

  • in_values (Array<String>) (defaults to: nil) —

    Specifies the allowed values for the property to match an event. An event will p

  • not_in_values (Array<String>) (defaults to: nil) —

    Specifies the values that prevent an event from matching the filter. An event wi




# File 'lib/metronome_sdk/models/property_filter.rb', line 39

Instance Attribute Details

#exists ⇒ Boolean?

Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.

Returns:

  • (Boolean, nil) 


19
 
# File 'lib/metronome_sdk/models/property_filter.rb', line 19

optional :exists, MetronomeSDK::Internal::Type::Boolean

#in_values ⇒ Array<String>?

Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.

Returns:

  • (Array<String>, nil) 


28
 
# File 'lib/metronome_sdk/models/property_filter.rb', line 28

optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]

#name ⇒ String

The name of the event property.

Returns:

  • (String) 


10
 
# File 'lib/metronome_sdk/models/property_filter.rb', line 10

required :name, String

#not_in_values ⇒ Array<String>?

Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.

Returns:

  • (Array<String>, nil) 


37
 
# File 'lib/metronome_sdk/models/property_filter.rb', line 37

optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]