Class: OCI::ApmTraces::Models::TraceSnapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_traces/models/trace_snapshot.rb

Overview

Definition of a trace snapshot object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TraceSnapshot

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 76

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

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.trace_snapshot_details = attributes[:'traceSnapshotDetails'] if attributes[:'traceSnapshotDetails']

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

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

  self.span_snapshots = attributes[:'spanSnapshots'] if attributes[:'spanSnapshots']

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

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

Instance Attribute Details

#key ⇒ String

[Required] Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 17

def key
  @key
end

#span_snapshots ⇒ Array<OCI::ApmTraces::Models::SpanSnapshot>

[Required] List of spans.

Returns:



37
38
39
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 37

def span_snapshots
  @span_snapshots
end

#time_ended ⇒ DateTime

End time of the trace.

Returns:

  • (DateTime) 


27
28
29
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 27

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

Start time of the trace.

Returns:

  • (DateTime) 


22
23
24
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 22

def time_started
  @time_started
end

#trace_snapshot_details ⇒ Array<OCI::ApmTraces::Models::SnapshotDetail>

Trace snapshots properties.

Returns:



32
33
34
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 32

def trace_snapshot_details
  @trace_snapshot_details
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'trace_snapshot_details': :'traceSnapshotDetails',
    'span_snapshots': :'spanSnapshots'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'trace_snapshot_details': :'Array<OCI::ApmTraces::Models::SnapshotDetail>',
    'span_snapshots': :'Array<OCI::ApmTraces::Models::SpanSnapshot>'
    # 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



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 116

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

  self.class == other.class &&
    key == other.key &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    trace_snapshot_details == other.trace_snapshot_details &&
    span_snapshots == other.span_snapshots
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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 150

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


130
131
132
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 139

def hash
  [key, time_started, time_ended, trace_snapshot_details, span_snapshots].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 183

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



177
178
179
 
# File 'lib/oci/apm_traces/models/trace_snapshot.rb', line 177

def to_s
  to_hash.to_s
end