Class: SourcesApiClient::GraphQLRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/sources-api-client/models/graph_ql_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GraphQLRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 53

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SourcesApiClient::GraphQLRequest` 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 `SourcesApiClient::GraphQLRequest`. 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?(:'query')
    self.query = attributes[:'query']
  else
    self.query = '{}'
  end

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

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

Instance Attribute Details

#operation_nameObject

If the Query contains several named operations, the operationName controls which one should be executed


21
22
23
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 21

def operation_name
  @operation_name
end

#queryObject

The GraphQL query


18
19
20
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 18

def query
  @query
end

#variablesObject

Optional Query variables


24
25
26
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 24

def variables
  @variables
end

Class Method Details

.attribute_mapObject

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


27
28
29
30
31
32
33
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 27

def self.attribute_map
  {
    :'query' => :'query',
    :'operation_name' => :'operationName',
    :'variables' => :'variables'
  }
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


126
127
128
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 126

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

.openapi_nullableObject

List of attributes with nullable: true


45
46
47
48
49
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 45

def self.openapi_nullable
  Set.new([
    :'variables'
  ])
end

.openapi_typesObject

Attribute type mapping.


36
37
38
39
40
41
42
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 36

def self.openapi_types
  {
    :'query' => :'String',
    :'operation_name' => :'String',
    :'variables' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


103
104
105
106
107
108
109
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      operation_name == o.operation_name &&
      variables == o.variables
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


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
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 154

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
    SourcesApiClient.const_get(type).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


223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 223

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


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 133

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

113
114
115
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 113

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


119
120
121
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 119

def hash
  [query, operation_name, variables].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


85
86
87
88
89
90
91
92
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 85

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


199
200
201
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 199

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 205

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


193
194
195
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 193

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


96
97
98
99
# File 'lib/sources-api-client/models/graph_ql_request.rb', line 96

def valid?
  return false if @query.nil?
  true
end