Class: DatadogAPIClient::V1::SyntheticsAPITestConfig

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/synthetics_api_test_config.rb

Overview

Configuration object for a Synthetic API test.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



39
40
41
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 39

def additional_properties
  @additional_properties
end

#assertions ⇒ Object

Array of assertions used for the test. Required for single API tests.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 26

def assertions
  @assertions
end

#config_variables ⇒ Object

Array of variables used for the test.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 29

def config_variables
  @config_variables
end

#request ⇒ Object

Object describing the Synthetic test request.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 31

def request
  @request
end

#steps ⇒ Object

When the test subtype is multi, the steps of the test.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 34

def steps
  @steps
end

#variables_from_script ⇒ Object

Variables defined from JavaScript code.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 37

def variables_from_script
  @variables_from_script
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 47

def self.acceptable_attributes
  attribute_map.values
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



144
145
146
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 144

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 62

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

Instance Method Details

#_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



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
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 174

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 :Array
    # generic array, 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 = DatadogAPIClient::V1.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 252

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 151

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


131
132
133
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 131

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



107
108
109
110
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 107

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



228
229
230
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 228

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



222
223
224
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 222

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



114
115
116
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test_config.rb', line 114

def valid?
  true
end