Class: DatadogAPIClient::V1::SyntheticsBasicAuthSigv4

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

Overview

Object to handle SIGV4 authentication when performing the 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_basic_auth_sigv4.rb', line 23

def _unparsed
  @_unparsed
end

#access_key ⇒ Object

Access key for the SIGV4 authentication.



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

def access_key
  @access_key
end

#region ⇒ Object

Region for the SIGV4 authentication.



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

def region
  @region
end

#secret_key ⇒ Object

Secret key for the SIGV4 authentication.



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

def secret_key
  @secret_key
end

#service_name ⇒ Object

Service name for the SIGV4 authentication.



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

def service_name
  @service_name
end

#session_token ⇒ Object

Session token for the SIGV4 authentication.



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

def session_token
  @session_token
end

#type ⇒ Object

The type of authentication to use when performing the test.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 55

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



175
176
177
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 175

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 72

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



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 205

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 283

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 182

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


162
163
164
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 162

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 121

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

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



259
260
261
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 259

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



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

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



253
254
255
 
# File 'lib/datadog_api_client/v1/models/synthetics_basic_auth_sigv4.rb', line 253

def to_s
  to_hash.to_s
end