Class: UltracartClient::ReportDataSet

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/report_data_set.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportDataSet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
228
229
230
231
232
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ReportDataSet` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ReportDataSet`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'data_set_query_uuid')
    self.data_set_query_uuid = attributes[:'data_set_query_uuid']
  end

  if attributes.key?(:'data_set_uuid')
    self.data_set_uuid = attributes[:'data_set_uuid']
  end

  if attributes.key?(:'destination_table_id')
    self.destination_table_id = attributes[:'destination_table_id']
  end

  if attributes.key?(:'error_message')
    self.error_message = attributes[:'error_message']
  end

  if attributes.key?(:'executed_sql')
    self.executed_sql = attributes[:'executed_sql']
  end

  if attributes.key?(:'for_object_id')
    self.for_object_id = attributes[:'for_object_id']
  end

  if attributes.key?(:'for_object_type')
    self.for_object_type = attributes[:'for_object_type']
  end

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

  if attributes.key?(:'max_results')
    self.max_results = attributes[:'max_results']
  end

  if attributes.key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.key?(:'page_count')
    self.page_count = attributes[:'page_count']
  end

  if attributes.key?(:'page_size')
    self.page_size = attributes[:'page_size']
  end

  if attributes.key?(:'request_dts')
    self.request_dts = attributes[:'request_dts']
  end

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

  if attributes.key?(:'security_level')
    self.security_level = attributes[:'security_level']
  end

  if attributes.key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.key?(:'user_data')
    self.user_data = attributes[:'user_data']
  end
end

Instance Attribute Details

#data_set_query_uuid ⇒ Object

A unique identifier assigned to the data set query that is returned.



19
20
21
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 19

def data_set_query_uuid
  @data_set_query_uuid
end

#data_set_uuid ⇒ Object

A unique identifier assigned to the data set that is returned.



22
23
24
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 22

def data_set_uuid
  @data_set_uuid
end

#destination_table_id ⇒ Object

The BigQuery destination table id that contains the result.



25
26
27
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 25

def destination_table_id
  @destination_table_id
end

#error_message ⇒ Object

Error message if the query failed.



28
29
30
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 28

def error_message
  @error_message
end

#executed_sql ⇒ Object

Returns the value of attribute executed_sql.



30
31
32
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 30

def executed_sql
  @executed_sql
end

#for_object_id ⇒ Object

An identifier that can be used to help match up the returned data set



33
34
35
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 33

def for_object_id
  @for_object_id
end

#for_object_type ⇒ Object

The type of object this data set is for



36
37
38
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 36

def for_object_type
  @for_object_type
end

#initial_pages ⇒ Object

Initial pages returned in the dataset



39
40
41
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 39

def initial_pages
  @initial_pages
end

#max_results ⇒ Object

The total number of results



42
43
44
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 42

def max_results
  @max_results
end

#merchant_id ⇒ Object

Merchant that owns this data set



45
46
47
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 45

def merchant_id
  @merchant_id
end

#page_count ⇒ Object

The total number of pages in the result set



48
49
50
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 48

def page_count
  @page_count
end

#page_size ⇒ Object

The size of the pages



51
52
53
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 51

def page_size
  @page_size
end

#request_dts ⇒ Object

Date/Time of the client submitted the request. Can be used to resolve out of order query completion results



54
55
56
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 54

def request_dts
  @request_dts
end

#schema ⇒ Object

The schema associated with the data set.



57
58
59
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 57

def schema
  @schema
end

#security_level ⇒ Object

Security level this dataset was read from.



60
61
62
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 60

def security_level
  @security_level
end

#timezone ⇒ Object

Returns the value of attribute timezone.



62
63
64
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 62

def timezone
  @timezone
end

#user_data ⇒ Object

Any other data that needs to be returned with the response to help the UI



65
66
67
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 65

def user_data
  @user_data
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 90

def self.attribute_map
  {
    :'data_set_query_uuid' => :'data_set_query_uuid',
    :'data_set_uuid' => :'data_set_uuid',
    :'destination_table_id' => :'destination_table_id',
    :'error_message' => :'error_message',
    :'executed_sql' => :'executed_sql',
    :'for_object_id' => :'for_object_id',
    :'for_object_type' => :'for_object_type',
    :'initial_pages' => :'initial_pages',
    :'max_results' => :'max_results',
    :'merchant_id' => :'merchant_id',
    :'page_count' => :'page_count',
    :'page_size' => :'page_size',
    :'request_dts' => :'request_dts',
    :'schema' => :'schema',
    :'security_level' => :'security_level',
    :'timezone' => :'timezone',
    :'user_data' => :'user_data'
  }
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



298
299
300
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 298

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 141

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 118

def self.openapi_types
  {
    :'data_set_query_uuid' => :'String',
    :'data_set_uuid' => :'String',
    :'destination_table_id' => :'String',
    :'error_message' => :'String',
    :'executed_sql' => :'String',
    :'for_object_id' => :'String',
    :'for_object_type' => :'String',
    :'initial_pages' => :'Array<ReportDataSetPage>',
    :'max_results' => :'Integer',
    :'merchant_id' => :'String',
    :'page_count' => :'Integer',
    :'page_size' => :'Integer',
    :'request_dts' => :'String',
    :'schema' => :'Array<ReportDataSetSchema>',
    :'security_level' => :'String',
    :'timezone' => :'String',
    :'user_data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_set_query_uuid == o.data_set_query_uuid &&
      data_set_uuid == o.data_set_uuid &&
      destination_table_id == o.destination_table_id &&
      error_message == o.error_message &&
      executed_sql == o.executed_sql &&
      for_object_id == o.for_object_id &&
      for_object_type == o.for_object_type &&
      initial_pages == o.initial_pages &&
      max_results == o.max_results &&
      merchant_id == o.merchant_id &&
      page_count == o.page_count &&
      page_size == o.page_size &&
      request_dts == o.request_dts &&
      schema == o.schema &&
      security_level == o.security_level &&
      timezone == o.timezone &&
      user_data == o.user_data
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 400

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 305

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 291

def hash
  [data_set_query_uuid, data_set_uuid, destination_table_id, error_message, executed_sql, for_object_id, for_object_type, initial_pages, max_results, merchant_id, page_count, page_size, request_dts, schema, security_level, timezone, user_data].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



236
237
238
239
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 236

def list_invalid_properties
  invalid_properties = Array.new
  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



376
377
378
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 376

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 382

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



370
371
372
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 370

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



243
244
245
246
247
 
# File 'lib/ultracart_api/models/report_data_set.rb', line 243

def valid?
  for_object_type_validator = EnumAttributeValidator.new('String', ["schema", "filter", "visualization"])
  return false unless for_object_type_validator.valid?(@for_object_type)
  true
end