Class: DatadogAPIClient::V1::SyntheticsBrowserVariable

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

Overview

Object defining a variable that can be used in your browser test. See the Recording Steps documentation.

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_browser_variable.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#example ⇒ Object

Example for the variable.



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

def example
  @example
end

#id ⇒ Object

ID for the variable. Global variables require an ID.



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

def id
  @id
end

#name ⇒ Object

Name of the variable.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 32

def name
  @name
end

#pattern ⇒ Object

Pattern of the variable.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 35

def pattern
  @pattern
end

#secure ⇒ Object

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 38

def secure
  @secure
end

#type ⇒ Object

Type of browser test variable.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



158
159
160
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 158

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 67

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



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 188

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 266

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 165

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


145
146
147
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 145

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



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 110

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



242
243
244
 
# File 'lib/datadog_api_client/v1/models/synthetics_browser_variable.rb', line 242

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

def to_s
  to_hash.to_s
end