class PureCloud::GroupSearchCriteria

Attributes

end_value[RW]

The end value of the range. This field is used for range search types.

fields[RW]

Field names to search against

group[RW]

Groups multiple conditions

operator[RW]

How to apply this search criteria against other criteria

start_value[RW]

The start value of the range. This field is used for range search types.

type[RW]

Search Type

value[RW]

A value for the search to match against

values[RW]

A list of values for the search to match against

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/group_search_criteria.rb, line 46
def self.attribute_map
  {
    
    :'end_value' => :'endValue',
    
    :'values' => :'values',
    
    :'start_value' => :'startValue',
    
    :'fields' => :'fields',
    
    :'value' => :'value',
    
    :'operator' => :'operator',
    
    :'group' => :'group',
    
    :'type' => :'type'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/group_search_criteria.rb, line 83
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[:'endValue']
    self.end_value = attributes[:'endValue']
  end
  
  if attributes[:'values']
    if (value = attributes[:'values']).is_a?(Array)
      self.values = value
    end
  end
  
  if attributes[:'startValue']
    self.start_value = attributes[:'startValue']
  end
  
  if attributes[:'fields']
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'operator']
    self.operator = attributes[:'operator']
  end
  
  if attributes[:'group']
    if (value = attributes[:'group']).is_a?(Array)
      self.group = value
    end
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/group_search_criteria.rb, line 69
def self.swagger_types
  {
    :'end_value' => :'String',
    :'values' => :'Array<String>',
    :'start_value' => :'String',
    :'fields' => :'Array<String>',
    :'value' => :'String',
    :'operator' => :'String',
    :'group' => :'Array<GroupSearchCriteria>',
    :'type' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/group_search_criteria.rb, line 149
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_value == o.end_value &&
      values == o.values &&
      start_value == o.start_value &&
      fields == o.fields &&
      value == o.value &&
      operator == o.operator &&
      group == o.group &&
      type == o.type
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/group_search_criteria.rb, line 192
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/purecloud/models/group_search_criteria.rb, line 252
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/purecloud/models/group_search_criteria.rb, line 173
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

# File lib/purecloud/models/group_search_criteria.rb, line 163
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/group_search_criteria.rb, line 168
def hash
  [end_value, values, start_value, fields, value, operator, group, type].hash
end
operator=(operator) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/group_search_criteria.rb, line 131
def operator=(operator)
  allowed_values = ["AND", "OR", "NOT"]
  if operator && !allowed_values.include?(operator)
    fail "invalid value for 'operator', must be one of #{allowed_values}"
  end
  @operator = operator
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/group_search_criteria.rb, line 235
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/group_search_criteria.rb, line 240
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/purecloud/models/group_search_criteria.rb, line 230
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/group_search_criteria.rb, line 140
def type=(type)
  allowed_values = ["EXACT", "STARTS_WITH", "CONTAINS", "REGEX", "TERM", "TERMS", "REQUIRED_FIELDS", "MATCH_ALL"]
  if type && !allowed_values.include?(type)
    fail "invalid value for 'type', must be one of #{allowed_values}"
  end
  @type = type
end