class PureCloud::Integration
Details for an Integration
Attributes
Read-only attributes for the integration.
Configuration
information for the integration.
The globally unique identifier for the object.
Type of the integration
Configured state of the integration.
The name of the integration, used to distinguish this integration from others of the same type.
Notes about the integration.
Last reported status of the integration.
The URI for this object
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/integration.rb, line 50 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'integration_type' => :'integrationType', :'notes' => :'notes', :'intended_state' => :'intendedState', :'config' => :'config', :'reported_state' => :'reportedState', :'attributes' => :'attributes', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/integration.rb, line 101 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?(:'integrationType') self.integration_type = attributes[:'integrationType'] end if attributes.has_key?(:'notes') self.notes = attributes[:'notes'] end if attributes.has_key?(:'intendedState') self.intended_state = attributes[:'intendedState'] end if attributes.has_key?(:'config') self.config = attributes[:'config'] end if attributes.has_key?(:'reportedState') self.reported_state = attributes[:'reportedState'] end if attributes.has_key?(:'attributes') if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/integration.rb, line 75 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'integration_type' => :'IntegrationType', :'notes' => :'String', :'intended_state' => :'String', :'config' => :'IntegrationConfigurationInfo', :'reported_state' => :'IntegrationStatusInfo', :'attributes' => :'Hash<String, String>', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/integration.rb, line 311 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && integration_type == o.integration_type && notes == o.notes && intended_state == o.intended_state && config == o.config && reported_state == o.reported_state && attributes == o.attributes && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/integration.rb, line 357 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/purecloudplatformclientv2/models/integration.rb, line 417 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/purecloudplatformclientv2/models/integration.rb, line 338 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/integration.rb, line 327 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/integration.rb, line 333 def hash [id, name, integration_type, notes, intended_state, config, reported_state, attributes, self_uri].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] intended_state
Object to be assigned
# File lib/purecloudplatformclientv2/models/integration.rb, line 278 def intended_state=(intended_state) allowed_values = ["ENABLED", "DISABLED", "DELETED"] if intended_state && !allowed_values.include?(intended_state) fail ArgumentError, "invalid value for 'intended_state', must be one of #{allowed_values}." end @intended_state = intended_state end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/integration.rb, line 195 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/integration.rb, line 405 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/purecloudplatformclientv2/models/integration.rb, line 395 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/integration.rb, line 204 def valid? if @intended_state.nil? return false end allowed_values = ["ENABLED", "DISABLED", "DELETED"] if @intended_state && !allowed_values.include?(@intended_state) return false end end