Class: Wallee::AnalyticsQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/analytics_query.rb

Overview

Represents a query to be submitted for execution in Analytics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsQuery

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 67

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?(:'accountId')
    self. = attributes[:'accountId']
  end

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The mandatory ID of an account in which the query shall be executed. Must be a valid account ID greater than 0.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 24

def 
  @account_id
end

#external_id ⇒ Object

A client generated nonce which uniquely identifies the query to be executed. Subsequent submissions with the same external ID will not re-execute the query but instead return the existing execution with that ID. Either the External ID or a Maximal Cache Age greater than 0 must be specified. If both are specified the External ID will have precedence and the Maximal Cache Age will be ignored.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 27

def external_id
  @external_id
end

#max_cache_age ⇒ Object

The maximal age in minutes of cached query executions to return. If an equivalent query execution with the same Query String, Account ID and Spaces parameters not older than the specified age is already available that execution will be returned instead of a newly started execution. Set to 0 or null (and set a unique, previously unused External ID) to force a new query execution irrespective of previous executions. Either the External ID or a Cache Duration greater than 0 must be specified. If both are specified, the External ID will be preferred (and the Maximal Cache Age ignored).



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 30

def max_cache_age
  @max_cache_age
end

#query_string ⇒ Object

The SQL statement which is being submitted for execution. Must be a valid PrestoDB/Athena SQL statement.



33
34
35
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 33

def query_string
  @query_string
end

#scanned_data_limit ⇒ Object

The maximal amount of scanned data that this query is allowed to scan. After this limit is reached query will be canceled by the system.



36
37
38
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 36

def scanned_data_limit
  @scanned_data_limit
end

#space_ids ⇒ Object

The IDs of the spaces in which the query shall be executed. At most 5 space IDs may be specified. All specified spaces must be owned by the account specified by the accountId property. The spaces property may be missing or empty to query all spaces of the specified account.



39
40
41
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 39

def space_ids
  @space_ids
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 42

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'external_id' => :'externalId',
    :'max_cache_age' => :'maxCacheAge',
    :'query_string' => :'queryString',
    :'scanned_data_limit' => :'scannedDataLimit',
    :'space_ids' => :'spaceIds'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 54

def self.swagger_types
  {
    :'account_id' => :'Integer',
    :'external_id' => :'String',
    :'max_cache_age' => :'Integer',
    :'query_string' => :'String',
    :'scanned_data_limit' => :'Float',
    :'space_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      external_id == o.external_id &&
      max_cache_age == o.max_cache_age &&
      query_string == o.query_string &&
      scanned_data_limit == o.scanned_data_limit &&
      space_ids == o.space_ids
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 191

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 = Wallee.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 257

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 170

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 163

def hash
  [, external_id, max_cache_age, query_string, scanned_data_limit, space_ids].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 102

def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if !@query_string.nil? && @query_string.to_s.length > 4096
    invalid_properties.push('invalid value for "query_string", the character length must be smaller than or equal to 4096.')
  end

  if !@query_string.nil? && @query_string.to_s.length < 1
    invalid_properties.push('invalid value for "query_string", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 243

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



231
232
233
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 231

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



121
122
123
124
125
126
 
# File 'lib/wallee-ruby-sdk/models/analytics_query.rb', line 121

def valid?
  return false if @account_id.nil?
  return false if !@query_string.nil? && @query_string.to_s.length > 4096
  return false if !@query_string.nil? && @query_string.to_s.length < 1
  true
end