class PureCloud::Trunk

Attributes

connected_status[RW]

The connected status of the trunk

created_by[RW]

The ID of the user that created the resource.

created_by_app[RW]

The application that created the resource.

date_created[RW]

The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_modified[RW]

The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

description[RW]

The resource's description.

edge[RW]

The Edge using this trunk.

edge_group[RW]

The edge group associated with this trunk.

enabled[RW]

True if the Edge used by this trunk is in-service

family[RW]

The IP Network Family of the trunk

id[RW]

The globally unique identifier for the object.

in_service[RW]

True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.

ip_status[RW]

The trunk ipStatus

logical_interface[RW]

The Logical Interface on the Edge to which the trunk is assigned.

modified_by[RW]

The ID of the user that last modified the resource.

modified_by_app[RW]

The application that last modified the resource.

name[RW]

The name of the entity.

options_enabled_status[RW]

Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.

options_status[RW]

The trunk optionsStatus

proxy_address_list[RW]

The list of proxy addresses (ports if provided) for the trunk

registers_enabled_status[RW]

Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.

registers_status[RW]

The trunk registersStatus

self_uri[RW]

The URI for this object

state[RW]

Indicates if the resource is active, inactive, or deleted.

trunk_base[RW]

The trunk base configuration used on this trunk.

trunk_metabase[RW]

The metabase used to create this trunk.

trunk_type[RW]

The type of this trunk.

version[RW]

The current version of the resource.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/trunk.rb, line 106
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',
    
    :'trunk_type' => :'trunkType',
    
    :'edge' => :'edge',
    
    :'trunk_base' => :'trunkBase',
    
    :'trunk_metabase' => :'trunkMetabase',
    
    :'edge_group' => :'edgeGroup',
    
    :'in_service' => :'inService',
    
    :'enabled' => :'enabled',
    
    :'logical_interface' => :'logicalInterface',
    
    :'connected_status' => :'connectedStatus',
    
    :'options_status' => :'optionsStatus',
    
    :'registers_status' => :'registersStatus',
    
    :'ip_status' => :'ipStatus',
    
    :'options_enabled_status' => :'optionsEnabledStatus',
    
    :'registers_enabled_status' => :'registersEnabledStatus',
    
    :'family' => :'family',
    
    :'proxy_address_list' => :'proxyAddressList',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/trunk.rb, line 233
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}

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

  
  if attributes.has_key?(:'version')
    
    
    self.version = attributes[:'version']
    
  
  end

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'dateModified')
    
    
    self.date_modified = attributes[:'dateModified']
    
  
  end

  
  if attributes.has_key?(:'modifiedBy')
    
    
    self.modified_by = attributes[:'modifiedBy']
    
  
  end

  
  if attributes.has_key?(:'createdBy')
    
    
    self.created_by = attributes[:'createdBy']
    
  
  end

  
  if attributes.has_key?(:'state')
    
    
    self.state = attributes[:'state']
    
  
  end

  
  if attributes.has_key?(:'modifiedByApp')
    
    
    self.modified_by_app = attributes[:'modifiedByApp']
    
  
  end

  
  if attributes.has_key?(:'createdByApp')
    
    
    self.created_by_app = attributes[:'createdByApp']
    
  
  end

  
  if attributes.has_key?(:'trunkType')
    
    
    self.trunk_type = attributes[:'trunkType']
    
  
  end

  
  if attributes.has_key?(:'edge')
    
    
    self.edge = attributes[:'edge']
    
  
  end

  
  if attributes.has_key?(:'trunkBase')
    
    
    self.trunk_base = attributes[:'trunkBase']
    
  
  end

  
  if attributes.has_key?(:'trunkMetabase')
    
    
    self.trunk_metabase = attributes[:'trunkMetabase']
    
  
  end

  
  if attributes.has_key?(:'edgeGroup')
    
    
    self.edge_group = attributes[:'edgeGroup']
    
  
  end

  
  if attributes.has_key?(:'inService')
    
    
    self.in_service = attributes[:'inService']
    
  
  end

  
  if attributes.has_key?(:'enabled')
    
    
    self.enabled = attributes[:'enabled']
    
  
  end

  
  if attributes.has_key?(:'logicalInterface')
    
    
    self.logical_interface = attributes[:'logicalInterface']
    
  
  end

  
  if attributes.has_key?(:'connectedStatus')
    
    
    self.connected_status = attributes[:'connectedStatus']
    
  
  end

  
  if attributes.has_key?(:'optionsStatus')
    
    if (value = attributes[:'optionsStatus']).is_a?(Array)
      self.options_status = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'registersStatus')
    
    if (value = attributes[:'registersStatus']).is_a?(Array)
      self.registers_status = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'ipStatus')
    
    
    self.ip_status = attributes[:'ipStatus']
    
  
  end

  
  if attributes.has_key?(:'optionsEnabledStatus')
    
    
    self.options_enabled_status = attributes[:'optionsEnabledStatus']
    
  
  end

  
  if attributes.has_key?(:'registersEnabledStatus')
    
    
    self.registers_enabled_status = attributes[:'registersEnabledStatus']
    
  
  end

  
  if attributes.has_key?(:'family')
    
    
    self.family = attributes[:'family']
    
  
  end

  
  if attributes.has_key?(:'proxyAddressList')
    
    if (value = attributes[:'proxyAddressList']).is_a?(Array)
      self.proxy_address_list = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/trunk.rb, line 169
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',
    
    :'trunk_type' => :'String',
    
    :'edge' => :'DomainEntityRef',
    
    :'trunk_base' => :'DomainEntityRef',
    
    :'trunk_metabase' => :'DomainEntityRef',
    
    :'edge_group' => :'DomainEntityRef',
    
    :'in_service' => :'BOOLEAN',
    
    :'enabled' => :'BOOLEAN',
    
    :'logical_interface' => :'DomainEntityRef',
    
    :'connected_status' => :'TrunkConnectedStatus',
    
    :'options_status' => :'Array<TrunkMetricsOptions>',
    
    :'registers_status' => :'Array<TrunkMetricsRegisters>',
    
    :'ip_status' => :'TrunkMetricsNetworkTypeIp',
    
    :'options_enabled_status' => :'String',
    
    :'registers_enabled_status' => :'String',
    
    :'family' => :'Integer',
    
    :'proxy_address_list' => :'Array<String>',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/trunk.rb, line 831
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 &&
      trunk_type == o.trunk_type &&
      edge == o.edge &&
      trunk_base == o.trunk_base &&
      trunk_metabase == o.trunk_metabase &&
      edge_group == o.edge_group &&
      in_service == o.in_service &&
      enabled == o.enabled &&
      logical_interface == o.logical_interface &&
      connected_status == o.connected_status &&
      options_status == o.options_status &&
      registers_status == o.registers_status &&
      ip_status == o.ip_status &&
      options_enabled_status == o.options_enabled_status &&
      registers_enabled_status == o.registers_enabled_status &&
      family == o.family &&
      proxy_address_list == o.proxy_address_list &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/trunk.rb, line 896
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
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/trunk.rb, line 956
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/trunk.rb, line 877
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/trunk.rb, line 866
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/trunk.rb, line 872
def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, trunk_type, edge, trunk_base, trunk_metabase, edge_group, in_service, enabled, logical_interface, connected_status, options_status, registers_status, ip_status, options_enabled_status, registers_enabled_status, family, proxy_address_list, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/trunk.rb, line 502
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
options_enabled_status=(options_enabled_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] options_enabled_status Object to be assigned

# File lib/purecloudplatformclientv2/models/trunk.rb, line 789
def options_enabled_status=(options_enabled_status)
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if options_enabled_status && !allowed_values.include?(options_enabled_status)
    fail ArgumentError, "invalid value for 'options_enabled_status', must be one of #{allowed_values}."
  end
  @options_enabled_status = options_enabled_status
end
registers_enabled_status=(registers_enabled_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] registers_enabled_status Object to be assigned

# File lib/purecloudplatformclientv2/models/trunk.rb, line 803
def registers_enabled_status=(registers_enabled_status)
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if registers_enabled_status && !allowed_values.include?(registers_enabled_status)
    fail ArgumentError, "invalid value for 'registers_enabled_status', must be one of #{allowed_values}."
  end
  @registers_enabled_status = registers_enabled_status
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/trunk.rb, line 696
def state=(state)
  allowed_values = ["active", "inactive", "deleted"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/trunk.rb, line 939
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/trunk.rb, line 944
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/trunk.rb, line 934
def to_s
  to_hash.to_s
end
trunk_type=(trunk_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] trunk_type Object to be assigned

# File lib/purecloudplatformclientv2/models/trunk.rb, line 720
def trunk_type=(trunk_type)
  allowed_values = ["EXTERNAL", "PHONE", "EDGE"]
  if trunk_type && !allowed_values.include?(trunk_type)
    fail ArgumentError, "invalid value for 'trunk_type', must be one of #{allowed_values}."
  end
  @trunk_type = trunk_type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/trunk.rb, line 511
def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["EXTERNAL", "PHONE", "EDGE"]
  if @trunk_type && !allowed_values.include?(@trunk_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if @options_enabled_status && !allowed_values.include?(@options_enabled_status)
    return false
  end
  
  
  
  
  
  allowed_values = ["ENABLED", "DISABLED", "NOT_SUPPORTED"]
  if @registers_enabled_status && !allowed_values.include?(@registers_enabled_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end