Class: DatadogAPIClient::V1::SyntheticsAPITest

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

Overview

Object containing details about 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.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#config ⇒ Object

Configuration object for a Synthetic API test.



25
26
27
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 25

def config
  @config
end

#locations ⇒ Object

Array of locations used to run the test.



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

def locations
  @locations
end

#message ⇒ Object

Notification message associated with the test.



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

def message
  @message
end

#monitor_id ⇒ Object

The associated monitor ID.



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

def monitor_id
  @monitor_id
end

#name ⇒ Object

Name of the test.



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

def name
  @name
end

#options ⇒ Object

Object describing the extra options for a Synthetic test.



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

def options
  @options
end

#public_id ⇒ Object

The public ID for the test.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 42

def public_id
  @public_id
end

#status ⇒ Object

Define whether you want to start (live) or pause (paused) a Synthetic test.



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

def status
  @status
end

#subtype ⇒ Object

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 51

def subtype
  @subtype
end

#tags ⇒ Object

Array of tags attached to the test.



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

def tags
  @tags
end

#type ⇒ Object

Type of the Synthetic test, api.



57
58
59
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 57

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 71

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



235
236
237
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 235

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 93

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
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
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 265

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 343

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 242

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


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

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



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/datadog_api_client/v1/models/synthetics_api_test.rb', line 166

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

  if @locations.nil?
    invalid_properties.push('invalid value for "locations", locations cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @options.nil?
    invalid_properties.push('invalid value for "options", options cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



319
320
321
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 319

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



313
314
315
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_test.rb', line 313

def to_s
  to_hash.to_s
end