Class: Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/global_ip_latency_retrieve_response.rb

Defined Under Namespace

Classes: GlobalIP, MeanLatency, PercentileLatency, ProberLocation

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(amount: nil, unit: nil) ⇒ Object

Parameters:

  • amount (Float) (defaults to: nil) —

    The 99th percentile latency.

  • unit (String) (defaults to: nil) —

    The unit of the 99th percentile latency.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 16

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute global_ip
  #
  #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::GlobalIP, nil]
  optional :global_ip, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::GlobalIP }

  # @!attribute mean_latency
  #
  #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::MeanLatency, nil]
  optional :mean_latency, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::MeanLatency }

  # @!attribute percentile_latency
  #
  #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency, nil]
  optional :percentile_latency,
           -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency }

  # @!attribute prober_location
  #
  #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::ProberLocation, nil]
  optional :prober_location, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::ProberLocation }

  # @!attribute timestamp
  #   The timestamp of the metric.
  #
  #   @return [Time, nil]
  optional :timestamp, Time

  # @!method initialize(global_ip: nil, mean_latency: nil, percentile_latency: nil, prober_location: nil, timestamp: nil)
  #   @param global_ip [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::GlobalIP]
  #
  #   @param mean_latency [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::MeanLatency]
  #
  #   @param percentile_latency [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency]
  #
  #   @param prober_location [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::ProberLocation]
  #
  #   @param timestamp [Time] The timestamp of the metric.

  # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data#global_ip
  class GlobalIP < Telnyx::Internal::Type::BaseModel
    # @!attribute id
    #   Global IP ID.
    #
    #   @return [String, nil]
    optional :id, String

    response_only do
      # @!attribute ip_address
      #   The Global IP address.
      #
      #   @return [String, nil]
      optional :ip_address, String
    end

    # @!method initialize(id: nil, ip_address: nil)
    #   @param id [String] Global IP ID.
    #
    #   @param ip_address [String] The Global IP address.
  end

  # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data#mean_latency
  class MeanLatency < Telnyx::Internal::Type::BaseModel
    # @!attribute amount
    #   The average latency.
    #
    #   @return [Float, nil]
    optional :amount, Float

    # @!attribute unit
    #   The unit of the average latency.
    #
    #   @return [String, nil]
    optional :unit, String

    # @!method initialize(amount: nil, unit: nil)
    #   @param amount [Float] The average latency.
    #
    #   @param unit [String] The unit of the average latency.
  end

  # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data#percentile_latency
  class PercentileLatency < Telnyx::Internal::Type::BaseModel
    # @!attribute p_0
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P0, nil]
    optional :p_0,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P0 },
             api_name: :"0"

    # @!attribute p_100
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P100, nil]
    optional :p_100,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P100 },
             api_name: :"100"

    # @!attribute p_25
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P25, nil]
    optional :p_25,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P25 },
             api_name: :"25"

    # @!attribute p_50
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P50, nil]
    optional :p_50,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P50 },
             api_name: :"50"

    # @!attribute p_75
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P75, nil]
    optional :p_75,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P75 },
             api_name: :"75"

    # @!attribute p_90
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P90, nil]
    optional :p_90,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P90 },
             api_name: :"90"

    # @!attribute p_99
    #
    #   @return [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P99, nil]
    optional :p_99,
             -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P99 },
             api_name: :"99"

    # @!method initialize(p_0: nil, p_100: nil, p_25: nil, p_50: nil, p_75: nil, p_90: nil, p_99: nil)
    #   @param p_0 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P0]
    #   @param p_100 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P100]
    #   @param p_25 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P25]
    #   @param p_50 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P50]
    #   @param p_75 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P75]
    #   @param p_90 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P90]
    #   @param p_99 [Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency::P99]

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_0
    class P0 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The minimum latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the minimum latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The minimum latency.
      #
      #   @param unit [String] The unit of the minimum latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_100
    class P100 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The maximum latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the maximum latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The maximum latency.
      #
      #   @param unit [String] The unit of the maximum latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_25
    class P25 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The 25th percentile latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the 25th percentile latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The 25th percentile latency.
      #
      #   @param unit [String] The unit of the 25th percentile latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_50
    class P50 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The 50th percentile latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the 50th percentile latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The 50th percentile latency.
      #
      #   @param unit [String] The unit of the 50th percentile latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_75
    class P75 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The 75th percentile latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the 75th percentile latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The 75th percentile latency.
      #
      #   @param unit [String] The unit of the 75th percentile latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_90
    class P90 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The 90th percentile latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the 90th percentile latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The 90th percentile latency.
      #
      #   @param unit [String] The unit of the 90th percentile latency.
    end

    # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency#p_99
    class P99 < Telnyx::Internal::Type::BaseModel
      # @!attribute amount
      #   The 99th percentile latency.
      #
      #   @return [Float, nil]
      optional :amount, Float

      # @!attribute unit
      #   The unit of the 99th percentile latency.
      #
      #   @return [String, nil]
      optional :unit, String

      # @!method initialize(amount: nil, unit: nil)
      #   @param amount [Float] The 99th percentile latency.
      #
      #   @param unit [String] The unit of the 99th percentile latency.
    end
  end

  # @see Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data#prober_location
  class ProberLocation < Telnyx::Internal::Type::BaseModel
    # @!attribute id
    #   Location ID.
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute lat
    #   Latitude.
    #
    #   @return [Float, nil]
    optional :lat, Float

    # @!attribute lon
    #   Longitude.
    #
    #   @return [Float, nil]
    optional :lon, Float

    # @!attribute name
    #   Location name.
    #
    #   @return [String, nil]
    optional :name, String

    # @!method initialize(id: nil, lat: nil, lon: nil, name: nil)
    #   @param id [String] Location ID.
    #
    #   @param lat [Float] Latitude.
    #
    #   @param lon [Float] Longitude.
    #
    #   @param name [String] Location name.
  end
end

Instance Attribute Details

#global_ip ⇒ Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::GlobalIP?

Returns:



20
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 20

optional :global_ip, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::GlobalIP }

#mean_latency ⇒ Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::MeanLatency?

Returns:



25
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 25

optional :mean_latency, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::MeanLatency }

#percentile_latency ⇒ Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency?

Returns:



30
31
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 30

optional :percentile_latency,
-> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::PercentileLatency }

#prober_location ⇒ Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::ProberLocation?

Returns:



36
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 36

optional :prober_location, -> { Telnyx::Models::GlobalIPLatencyRetrieveResponse::Data::ProberLocation }

#timestamp ⇒ Time?

The timestamp of the metric.

Returns:

  • (Time, nil) 


42
 
# File 'lib/telnyx/models/global_ip_latency_retrieve_response.rb', line 42

optional :timestamp, Time