Class: PostFinanceCheckout::AnalyticsQueryExecution

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

Overview

Represents the execution of a query which has been submitted to Analytics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsQueryExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 97

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

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

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

  if attributes.has_key?(:'failureReason')
    self.failure_reason = attributes[:'failureReason']
  end

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

  if attributes.has_key?(:'processingEndTime')
    self.processing_end_time = attributes[:'processingEndTime']
  end

  if attributes.has_key?(:'processingStartTime')
    self.processing_start_time = attributes[:'processingStartTime']
  end

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

  if attributes.has_key?(:'scannedDataInGb')
    self.scanned_data_in_gb = attributes[:'scannedDataInGb']
  end

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

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

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

Instance Attribute Details

#account ⇒ Object

The account in which the query has been executed.



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

def 
  @account
end

#error_message ⇒ Object

The error message if and only if the query has failed, otherwise null.



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

def error_message
  @error_message
end

#external_id ⇒ Object

The External ID of the query if one had been specified; otherwise null.



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

def external_id
  @external_id
end

#failure_reason ⇒ Object

The reason of the failure if and only if the query has failed, otherwise null.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#processing_end_time ⇒ Object

The time at which processing of the query has finished (either successfully or by failure or by cancelation). Will be null if the query execution has not finished yet.



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

def processing_end_time
  @processing_end_time
end

#processing_start_time ⇒ Object

The time at which processing of the query has started (never null).



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 42

def processing_start_time
  @processing_start_time
end

#query_string ⇒ Object

The SQL statement which has been submitted for execution.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 45

def query_string
  @query_string
end

#scanned_data_in_gb ⇒ Object

The amount of data scanned while processing the query (in GB). (Note that this amount may increase over time while the query is still being processed and not finished yet.)



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 48

def scanned_data_in_gb
  @scanned_data_in_gb
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.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 51

def scanned_data_limit
  @scanned_data_limit
end

#spaces ⇒ Object

The spaces in which the query has been executed. May be empty if all spaces of the specified account have been queried.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 54

def spaces
  @spaces
end

#state ⇒ Object

The current state of the query execution.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 57

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 60

def self.attribute_map
  {
    :'account' => :'account',
    :'error_message' => :'errorMessage',
    :'external_id' => :'externalId',
    :'failure_reason' => :'failureReason',
    :'id' => :'id',
    :'processing_end_time' => :'processingEndTime',
    :'processing_start_time' => :'processingStartTime',
    :'query_string' => :'queryString',
    :'scanned_data_in_gb' => :'scannedDataInGb',
    :'scanned_data_limit' => :'scannedDataLimit',
    :'spaces' => :'spaces',
    :'state' => :'state'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 78

def self.swagger_types
  {
    :'account' => :'Integer',
    :'error_message' => :'String',
    :'external_id' => :'String',
    :'failure_reason' => :'FailureReason',
    :'id' => :'Integer',
    :'processing_end_time' => :'DateTime',
    :'processing_start_time' => :'DateTime',
    :'query_string' => :'String',
    :'scanned_data_in_gb' => :'Float',
    :'scanned_data_limit' => :'Float',
    :'spaces' => :'Array<Integer>',
    :'state' => :'AnalyticsQueryExecutionState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      error_message == o.error_message &&
      external_id == o.external_id &&
      failure_reason == o.failure_reason &&
      id == o.id &&
      processing_end_time == o.processing_end_time &&
      processing_start_time == o.processing_start_time &&
      query_string == o.query_string &&
      scanned_data_in_gb == o.scanned_data_in_gb &&
      scanned_data_limit == o.scanned_data_limit &&
      spaces == o.spaces &&
      state == o.state
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 222

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 = PostFinanceCheckout.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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 288

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 201

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


188
189
190
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 194

def hash
  [, error_message, external_id, failure_reason, id, processing_end_time, processing_start_time, query_string, scanned_data_in_gb, scanned_data_limit, spaces, state].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



156
157
158
159
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 156

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



268
269
270
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 268

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



274
275
276
277
278
279
280
281
282
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 274

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



262
263
264
 
# File 'lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution.rb', line 262

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



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

def valid?
  true
end