Class: DatadogAPIClient::V1::SyntheticsAPIStep

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/synthetics_api_step.rb

Overview

The steps used in a Synthetics multistep API test.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SyntheticsAPIStep

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 92

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

  if attributes.key?(:'assertions')
    if (value = attributes[:'assertions']).is_a?(Array)
      self.assertions = value
    end
  end

  if attributes.key?(:'extracted_values')
    if (value = attributes[:'extracted_values']).is_a?(Array)
      self.extracted_values = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#_retry ⇒ Object

Returns the value of attribute _retry.



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

def _retry
  @_retry
end

#allow_failure ⇒ Object

Determines whether or not to continue with test if this step fails.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 27

def allow_failure
  @allow_failure
end

#assertions ⇒ Object

Array of assertions used for the test.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 30

def assertions
  @assertions
end

#extracted_values ⇒ Object

Array of values to parse and save as variables from the response.



33
34
35
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 33

def extracted_values
  @extracted_values
end

#is_critical ⇒ Object

Determines whether or not to consider the entire test as failed if this step fails. Can be used only if ‘allowFailure` is `true`.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 36

def is_critical
  @is_critical
end

#name ⇒ Object

The name of the step.



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

def name
  @name
end

#request ⇒ Object

Returns the value of attribute request.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 41

def request
  @request
end

#subtype ⇒ Object

Returns the value of attribute subtype.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/synthetics_api_step.rb', line 45

def subtype
  @subtype
end