class DocuSign_Monitor::WebQuery

Attributes

aggregations[RW]
filters[RW]
query_scope[RW]
query_scope_id[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 47
def self.attribute_map
  {
    :'filters' => :'filters',
    :'aggregations' => :'aggregations',
    :'query_scope' => :'queryScope',
    :'query_scope_id' => :'queryScopeId'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 68
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?(:'filters')
    if (value = attributes[:'filters']).is_a?(Array)
      self.filters = value
    end
  end

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

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

  if attributes.has_key?(:'queryScopeId')
    self.query_scope_id = attributes[:'queryScopeId']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_monitor/models/web_query.rb, line 57
def self.swagger_types
  {
    :'filters' => :'Array<Filter>',
    :'aggregations' => :'Array<Aggregation>',
    :'query_scope' => :'String',
    :'query_scope_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 122
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filters == o.filters &&
      aggregations == o.aggregations &&
      query_scope == o.query_scope &&
      query_scope_id == o.query_scope_id
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_monitor/models/web_query.rb, line 167
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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = DocuSign_Monitor.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_monitor/models/web_query.rb, line 233
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

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_monitor/models/web_query.rb, line 146
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 133
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 139
def hash
  [filters, aggregations, query_scope, query_scope_id].hash
end
list_invalid_properties() click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 97
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
query_scope=(query_scope) click to toggle source

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

# File lib/docusign_monitor/models/web_query.rb, line 112
def query_scope=(query_scope)
  validator = EnumAttributeValidator.new('String', ['AccountId', 'OrganizationId', 'None'])
  unless validator.valid?(query_scope)
    fail ArgumentError, 'invalid value for "query_scope", must be one of #{validator.allowable_values}.'
  end
  @query_scope = query_scope
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_monitor/models/web_query.rb, line 213
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_monitor/models/web_query.rb, line 219
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

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_monitor/models/web_query.rb, line 207
def to_s
  to_hash.to_s
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/docusign_monitor/models/web_query.rb, line 104
def valid?
  query_scope_validator = EnumAttributeValidator.new('String', ['AccountId', 'OrganizationId', 'None'])
  return false unless query_scope_validator.valid?(@query_scope)
  true
end