class PureCloud::OutboundRoute
Attributes
The site associated to the outbound route.
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Trunk
base settings of trunkType "EXTERNAL". This base must also be set on an edge logical interface for correct routing.
The globally unique identifier for the object.
Is this outbound route being managed remotely.
The name of the entity.
The URI for this object
The site associated to the outbound route.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/outbound_route.rb, line 67 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'version' => :'version', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'modified_by' => :'modifiedBy', :'created_by' => :'createdBy', :'state' => :'state', :'modified_by_app' => :'modifiedByApp', :'created_by_app' => :'createdByApp', :'classification_types' => :'classificationTypes', :'enabled' => :'enabled', :'distribution' => :'distribution', :'external_trunk_bases' => :'externalTrunkBases', :'site' => :'site', :'managed' => :'managed', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/outbound_route.rb, line 134 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'description'] self.description = attributes[:'description'] end if attributes[:'version'] self.version = attributes[:'version'] end if attributes[:'dateCreated'] self.date_created = attributes[:'dateCreated'] end if attributes[:'dateModified'] self.date_modified = attributes[:'dateModified'] end if attributes[:'modifiedBy'] self.modified_by = attributes[:'modifiedBy'] end if attributes[:'createdBy'] self.created_by = attributes[:'createdBy'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'modifiedByApp'] self.modified_by_app = attributes[:'modifiedByApp'] end if attributes[:'createdByApp'] self.created_by_app = attributes[:'createdByApp'] end if attributes[:'classificationTypes'] if (value = attributes[:'classificationTypes']).is_a?(Array) self.classification_types = value end end if attributes[:'enabled'] self.enabled = attributes[:'enabled'] end if attributes[:'distribution'] self.distribution = attributes[:'distribution'] end if attributes[:'externalTrunkBases'] if (value = attributes[:'externalTrunkBases']).is_a?(Array) self.external_trunk_bases = value end end if attributes[:'site'] self.site = attributes[:'site'] end if attributes[:'managed'] self.managed = attributes[:'managed'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/outbound_route.rb, line 110 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'version' => :'Integer', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'modified_by' => :'String', :'created_by' => :'String', :'state' => :'String', :'modified_by_app' => :'String', :'created_by_app' => :'String', :'classification_types' => :'Array<String>', :'enabled' => :'BOOLEAN', :'distribution' => :'String', :'external_trunk_bases' => :'Array<UriReference>', :'site' => :'Site', :'managed' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/outbound_route.rb, line 238 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && version == o.version && date_created == o.date_created && date_modified == o.date_modified && modified_by == o.modified_by && created_by == o.created_by && state == o.state && modified_by_app == o.modified_by_app && created_by_app == o.created_by_app && classification_types == o.classification_types && enabled == o.enabled && distribution == o.distribution && external_trunk_bases == o.external_trunk_bases && site == o.site && managed == o.managed && self_uri == o.self_uri end
# File lib/purecloud/models/outbound_route.rb, line 291 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /^(true|t|yes|y|1)$/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/outbound_route.rb, line 351 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
build the object from hash
# File lib/purecloud/models/outbound_route.rb, line 272 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 if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/outbound_route.rb, line 229 def distribution=(distribution) allowed_values = ["SEQUENTIAL", "RANDOM"] if distribution && !allowed_values.include?(distribution) fail "invalid value for 'distribution', must be one of #{allowed_values}" end @distribution = distribution end
@see the `==` method
# File lib/purecloud/models/outbound_route.rb, line 262 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/outbound_route.rb, line 267 def hash [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, classification_types, enabled, distribution, external_trunk_bases, site, managed, self_uri].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/outbound_route.rb, line 220 def state=(state) allowed_values = ["active", "inactive", "deleted"] if state && !allowed_values.include?(state) fail "invalid value for 'state', must be one of #{allowed_values}" end @state = state end
return the object in the form of hash
# File lib/purecloud/models/outbound_route.rb, line 339 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
# File lib/purecloud/models/outbound_route.rb, line 329 def to_s to_hash.to_s end