Class: Twilio::REST::Voice::V1::ConnectionPolicyContext::ConnectionPolicyTargetInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Voice::V1::ConnectionPolicyContext::ConnectionPolicyTargetInstance
- Defined in:
- lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Target resource.
-
#connection_policy_sid ⇒ String
The SID of the Connection Policy that owns the Target.
-
#context ⇒ ConnectionPolicyTargetContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the ConnectionPolicyTargetInstance.
-
#enabled ⇒ Boolean
Whether the target is enabled.
-
#fetch ⇒ ConnectionPolicyTargetInstance
Fetch the ConnectionPolicyTargetInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, connection_policy_sid: nil, sid: nil) ⇒ ConnectionPolicyTargetInstance
constructor
Initialize the ConnectionPolicyTargetInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#priority ⇒ String
The relative importance of the target.
-
#sid ⇒ String
The unique string that we created to identify the Target resource.
-
#target ⇒ String
The SIP address you want Twilio to route your calls to.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, target: :unset, priority: :unset, weight: :unset, enabled: :unset) ⇒ ConnectionPolicyTargetInstance
Update the ConnectionPolicyTargetInstance.
-
#url ⇒ String
The absolute URL of the resource.
-
#weight ⇒ String
The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority.
Constructor Details
#initialize(version, payload, connection_policy_sid: nil, sid: nil) ⇒ ConnectionPolicyTargetInstance
Initialize the ConnectionPolicyTargetInstance
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 286 def initialize(version, payload , connection_policy_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'connection_policy_sid' => payload['connection_policy_sid'], 'sid' => payload['sid'], 'friendly_name' => payload['friendly_name'], 'target' => payload['target'], 'priority' => payload['priority'] == nil ? payload['priority'] : payload['priority'].to_i, 'weight' => payload['weight'] == nil ? payload['weight'] : payload['weight'].to_i, 'enabled' => payload['enabled'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], } # Context @instance_context = nil @params = { 'connection_policy_sid' => connection_policy_sid || @properties['connection_policy_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Target resource.
322 323 324 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 322 def account_sid @properties['account_sid'] end |
#connection_policy_sid ⇒ String
Returns The SID of the Connection Policy that owns the Target.
328 329 330 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 328 def connection_policy_sid @properties['connection_policy_sid'] end |
#context ⇒ ConnectionPolicyTargetContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
313 314 315 316 317 318 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 313 def context unless @instance_context @instance_context = ConnectionPolicyTargetContext.new(@version , @params['connection_policy_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
370 371 372 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 370 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
376 377 378 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 376 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ConnectionPolicyTargetInstance
389 390 391 392 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 389 def delete context.delete end |
#enabled ⇒ Boolean
Returns Whether the target is enabled. The default is ‘true`.
364 365 366 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 364 def enabled @properties['enabled'] end |
#fetch ⇒ ConnectionPolicyTargetInstance
Fetch the ConnectionPolicyTargetInstance
397 398 399 400 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 397 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
340 341 342 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 340 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
436 437 438 439 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 436 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Voice.V1.ConnectionPolicyTargetInstance #{values}>" end |
#priority ⇒ String
Returns The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target.
352 353 354 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 352 def priority @properties['priority'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Target resource.
334 335 336 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 334 def sid @properties['sid'] end |
#target ⇒ String
Returns The SIP address you want Twilio to route your calls to. This must be a ‘sip:` schema. `sips` is NOT supported.
346 347 348 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 346 def target @properties['target'] end |
#to_s ⇒ Object
Provide a user friendly representation
429 430 431 432 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 429 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Voice.V1.ConnectionPolicyTargetInstance #{values}>" end |
#update(friendly_name: :unset, target: :unset, priority: :unset, weight: :unset, enabled: :unset) ⇒ ConnectionPolicyTargetInstance
Update the ConnectionPolicyTargetInstance
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 410 def update( friendly_name: :unset, target: :unset, priority: :unset, weight: :unset, enabled: :unset ) context.update( friendly_name: friendly_name, target: target, priority: priority, weight: weight, enabled: enabled, ) end |
#url ⇒ String
Returns The absolute URL of the resource.
382 383 384 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 382 def url @properties['url'] end |
#weight ⇒ String
Returns The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority.
358 359 360 |
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 358 def weight @properties['weight'] end |