Class: OCI::ApmConfig::Models::SpanFilter

Inherits:
Config
  • Object
show all
Defined in:
lib/oci/apm_config/models/span_filter.rb

Overview

A named setting that specifies the filter criteria to match a subset of the spans.

Constant Summary

Constants inherited from Config

Config::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Config

#config_type, #created_by, #defined_tags, #etag, #freeform_tags, #id, #time_created, #time_updated, #updated_by

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Config

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SpanFilter

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :created_by (String) —

    The value to assign to the #created_by proprety

  • :updated_by (String) —

    The value to assign to the #updated_by proprety

  • :etag (String) —

    The value to assign to the #etag proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :display_name (String) —

    The value to assign to the #display_name property

  • :filter_text (String) —

    The value to assign to the #filter_text property

  • :in_use_by (Array<OCI::ApmConfig::Models::SpanFilterReference>) —

    The value to assign to the #in_use_by property

  • :description (String) —

    The value to assign to the #description property



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 89

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['configType'] = 'SPAN_FILTER'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.filter_text = attributes[:'filterText'] if attributes[:'filterText']

  raise 'You cannot provide both :filterText and :filter_text' if attributes.key?(:'filterText') && attributes.key?(:'filter_text')

  self.filter_text = attributes[:'filter_text'] if attributes[:'filter_text']

  self.in_use_by = attributes[:'inUseBy'] if attributes[:'inUseBy']

  raise 'You cannot provide both :inUseBy and :in_use_by' if attributes.key?(:'inUseBy') && attributes.key?(:'in_use_by')

  self.in_use_by = attributes[:'in_use_by'] if attributes[:'in_use_by']

  self.description = attributes[:'description'] if attributes[:'description']
end

Instance Attribute Details

#description ⇒ String

An optional string that describes what the span filter is intended or used for.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 27

def description
  @description
end

#display_name ⇒ String

The name by which a configuration entity is displayed to the end user.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 14

def display_name
  @display_name
end

#filter_text ⇒ String

The string that defines the Span Filter expression.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 19

def filter_text
  @filter_text
end

#in_use_by ⇒ Array<OCI::ApmConfig::Models::SpanFilterReference>

The list of configuration items that reference the span filter.

Returns:



23
24
25
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 23

def in_use_by
  @in_use_by
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'config_type': :'configType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'updated_by': :'updatedBy',
    'etag': :'etag',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'filter_text': :'filterText',
    'in_use_by': :'inUseBy',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'config_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'updated_by': :'String',
    'etag': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'filter_text': :'String',
    'in_use_by': :'Array<OCI::ApmConfig::Models::SpanFilterReference>',
    'description': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 127

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    config_type == other.config_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    updated_by == other.updated_by &&
    etag == other.etag &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    filter_text == other.filter_text &&
    in_use_by == other.in_use_by &&
    description == other.description
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 158

def hash
  [id, config_type, time_created, time_updated, created_by, updated_by, etag, freeform_tags, defined_tags, display_name, filter_text, in_use_by, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 202

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



196
197
198
 
# File 'lib/oci/apm_config/models/span_filter.rb', line 196

def to_s
  to_hash.to_s
end