Class: Stripe::V2::Data::Reporting::QueryRun

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/data/reporting/query_run.rb

Overview

The QueryRun object represents an ad-hoc SQL execution. Once created, Stripe processes the query. When the query has finished running, the object provides a reference to the results.

Defined Under Namespace

Classes: Result, ResultOptions, StatusDetails

Constant Summary collapse

OBJECT_NAME = 
"v2.data.reporting.query_run"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#created ⇒ Object (readonly)

Time at which the object was created.



116
117
118
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 116

def created
  @created
end

#id ⇒ Object (readonly)

The unique identifier of the QueryRun object.



118
119
120
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 118

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.



120
121
122
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 120

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object's type. Objects of the same type share the same value of the object field.



122
123
124
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 122

def object
  @object
end

#result ⇒ Object (readonly)

Details how to retrieve the results of a successfully completed QueryRun.



124
125
126
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 124

def result
  @result
end

#result_options ⇒ Object (readonly)

The options specified for customizing the output of the QueryRun.



126
127
128
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 126

def result_options
  @result_options
end

#sql ⇒ Object (readonly)

The SQL that was executed.



128
129
130
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 128

def sql
  @sql
end

#status ⇒ Object (readonly)

The current status of the QueryRun.



130
131
132
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 130

def status
  @status
end

#status_details ⇒ Object (readonly)

Additional details about the current state of the QueryRun. Populated when the QueryRun is in the failed state, providing more information about why the query failed.



133
134
135
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 133

def status_details
  @status_details
end

Class Method Details

.field_encodings ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 147

def self.field_encodings
  @field_encodings = {
    result: {
      kind: :object,
      fields: { file: { kind: :object, fields: { size: :int64_string } } },
    },
  }
end

.field_remappings ⇒ Object 



143
144
145
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 143

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



135
136
137
138
139
140
141
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 135

def self.inner_class_types
  @inner_class_types = {
    result: Result,
    result_options: ResultOptions,
    status_details: StatusDetails,
  }
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/v2/data/reporting/query_run.rb', line 12

def self.object_name
  "v2.data.reporting.query_run"
end