Class: Twilio::REST::Insights::V1::CallContext::MetricInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/insights/v1/call/metric.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, call_sid: nil) ⇒ MetricInstance

Initialize the MetricInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Metric resource.

  • sid (String) —

    The SID of the Call resource to fetch.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 177

def initialize(version, payload , call_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'timestamp' => payload['timestamp'],
        'call_sid' => payload['call_sid'],
        'account_sid' => payload['account_sid'],
        'edge' => payload['edge'],
        'direction' => payload['direction'],
        'carrier_edge' => payload['carrier_edge'],
        'sip_edge' => payload['sip_edge'],
        'sdk_edge' => payload['sdk_edge'],
        'client_edge' => payload['client_edge'],
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



209
210
211
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 209

def 
    @properties['account_sid']
end

#call_sid ⇒ String

Returns The unique SID identifier of the Call.

Returns:

  • (String) —

    The unique SID identifier of the Call.



203
204
205
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 203

def call_sid
    @properties['call_sid']
end

#carrier_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a PSTN call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a PSTN call.



227
228
229
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 227

def carrier_edge
    @properties['carrier_edge']
end

#client_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a Client call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a Client call.



245
246
247
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 245

def client_edge
    @properties['client_edge']
end

#direction ⇒ StreamDirection

Returns:

  • (StreamDirection) 


221
222
223
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 221

def direction
    @properties['direction']
end

#edge ⇒ TwilioEdge

Returns:

  • (TwilioEdge) 


215
216
217
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 215

def edge
    @properties['edge']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



257
258
259
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 257

def inspect
    "<Twilio.Insights.V1.MetricInstance>"
end

#sdk_edge ⇒ Hash

Returns Contains metrics and properties for the SDK sensor library for Client calls.

Returns:

  • (Hash) —

    Contains metrics and properties for the SDK sensor library for Client calls.



239
240
241
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 239

def sdk_edge
    @properties['sdk_edge']
end

#sip_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.



233
234
235
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 233

def sip_edge
    @properties['sip_edge']
end

#timestamp ⇒ String

Returns Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.

Returns:

  • (String) —

    Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.



197
198
199
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 197

def timestamp
    @properties['timestamp']
end

#to_s ⇒ Object

Provide a user friendly representation



251
252
253
 
# File 'lib/twilio-ruby/rest/insights/v1/call/metric.rb', line 251

def to_s
    "<Twilio.Insights.V1.MetricInstance>"
end