Class: OCI::ApmConfig::Models::TestSpanEnrichmentDetails

Inherits:
TestDetails
  • Object
show all
Defined in:
lib/oci/apm_config/models/test_span_enrichment_details.rb

Overview

Run a set of span enrichment rules on a given span to see the result.

Constant Summary

Constants inherited from TestDetails

OCI::ApmConfig::Models::TestDetails::TEST_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from TestDetails

#test_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TestDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ TestSpanEnrichmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 60

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

  attributes['testType'] = 'SPAN_ENRICHMENT'

  super(attributes)

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

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

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

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

Instance Attribute Details

#filters ⇒ Array<OCI::ApmConfig::Models::FilterTextOrId>

A list of filters to try against the given span.

Returns:



18
19
20
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 18

def filters
  @filters
end

#options ⇒ Object

[Required] The span enrichment rules to test in the format of an Options resource.

Returns:

  • (Object) 


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

def options
  @options
end

#span ⇒ Object

[Required] The span to test the rules on. This should be a valid JSON object that follows one of the formats used by distributed tracing frameworks, such as OpenTelemetry, Zipkin, or Oracle Application Performance Monitoring.

Returns:

  • (Object) 


25
26
27
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 25

def span
  @span
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'test_type': :'testType',
    'options': :'options',
    'filters': :'filters',
    'span': :'span'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'test_type': :'String',
    'options': :'Object',
    'filters': :'Array<OCI::ApmConfig::Models::FilterTextOrId>',
    'span': :'Object'
    # 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



84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 84

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

  self.class == other.class &&
    test_type == other.test_type &&
    options == other.options &&
    filters == other.filters &&
    span == other.span
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 117

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


97
98
99
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 106

def hash
  [test_type, options, filters, span].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 150

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



144
145
146
 
# File 'lib/oci/apm_config/models/test_span_enrichment_details.rb', line 144

def to_s
  to_hash.to_s
end