Class: DatadogAPIClient::V1::SyntheticsCITest

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

Overview

Configuration for Continuous Testing.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_retry ⇒ Object

Object describing the retry strategy to apply to a Synthetic test.



58
59
60
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 58

def _retry
  @_retry
end

#_unparsed ⇒ Object

whether the object has unparsed attributes



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

def _unparsed
  @_unparsed
end

#allow_insecure_certificates ⇒ Object

Disable certificate checks in API tests.



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

def allow_insecure_certificates
  @allow_insecure_certificates
end

#basic_auth ⇒ Object

Object to handle basic authentication when performing the test.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 28

def basic_auth
  @basic_auth
end

#body ⇒ Object

Body to include in the test.



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

def body
  @body
end

#body_type ⇒ Object

Type of the data sent in a Synthetic API test.



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

def body_type
  @body_type
end

#cookies ⇒ Object

Cookies for the request.



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

def cookies
  @cookies
end

#device_ids ⇒ Object

For browser test, array with the different device IDs used to run the test.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 40

def device_ids
  @device_ids
end

#follow_redirects ⇒ Object

For API HTTP test, whether or not the test should follow redirects.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 43

def follow_redirects
  @follow_redirects
end

#headers ⇒ Object

Headers to include when performing the test.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 46

def headers
  @headers
end

#locations ⇒ Object

Array of locations used to run the test.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 49

def locations
  @locations
end

#metadata ⇒ Object

Metadata for the Synthetic tests run.



52
53
54
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 52

def metadata
  @metadata
end

#public_id ⇒ Object

The public ID of the Synthetic test to trigger.



54
55
56
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 54

def public_id
  @public_id
end

#start_url ⇒ Object

Starting URL for the browser test.



59
60
61
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 59

def start_url
  @start_url
end

#variables ⇒ Object

Variables to replace in the test.



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

def variables
  @variables
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 85

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



249
250
251
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 249

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 110

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 279

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 357

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 256

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


236
237
238
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 236

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



197
198
199
200
201
202
203
204
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 197

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

  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



333
334
335
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 339

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



327
328
329
 
# File 'lib/datadog_api_client/v1/models/synthetics_ci_test.rb', line 327

def to_s
  to_hash.to_s
end