Class: IntersightClient::ConnectorHttpRequest

Inherits:
ConnectorBaseMessage show all
Defined in:
lib/intersight_client/models/connector_http_request.rb

Overview

A HTTP request sent by a cloud service to be proxied through a device connector.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ConnectorBaseMessage

#encrypted_aes_key, #encryption_key, #secure_properties

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectorHttpRequest

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 140

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::ConnectorHttpRequest` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'connector.HttpRequest'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'connector.HttpRequest'
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_target_moid ⇒ Object

The Target endpoint Moid which is used to fetch the previously persisted Target information in Intersight to create HTTP request along with any authentication info specifed.



26
27
28
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 26

def asset_target_moid
  @asset_target_moid
end

#body ⇒ Object

Contents of the request body to send for PUT/PATCH/POST requests.



29
30
31
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 29

def body
  @body
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 20

def class_id
  @class_id
end

#dial_timeout ⇒ Object

The timeout for establishing the TCP connection to the target host. If not set the request timeout value is used.



32
33
34
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 32

def dial_timeout
  @dial_timeout
end

#endpoint_moid ⇒ Object

The MO id of the asset.EndpointConnection this request is directed to. If set plugin will insert connection details into the request, including credentials if defined.



35
36
37
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 35

def endpoint_moid
  @endpoint_moid
end

#header ⇒ Object

Collection of key value pairs to set in the request header.



38
39
40
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 38

def header
  @header
end

#internal ⇒ Object

The request is for an internal platform API that requires authentication to be inserted by the platform implementation.



41
42
43
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 41

def internal
  @internal
end

#method ⇒ Object

Method specifies the HTTP method (GET, POST, PUT, etc.). For client requests an empty string means GET.



44
45
46
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 44

def method
  @method
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 23

def object_type
  @object_type
end

#timeout ⇒ Object

The timeout for the HTTP request to complete, from connection establishment to response body read complete. If not set a default timeout of five minutes is used.



47
48
49
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 47

def timeout
  @timeout
end

#url ⇒ Object

Returns the value of attribute url.



49
50
51
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 49

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



96
97
98
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 96

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



91
92
93
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 91

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 74

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'asset_target_moid' => :'AssetTargetMoid',
    :'body' => :'Body',
    :'dial_timeout' => :'DialTimeout',
    :'endpoint_moid' => :'EndpointMoid',
    :'header' => :'Header',
    :'internal' => :'Internal',
    :'method' => :'Method',
    :'timeout' => :'Timeout',
    :'url' => :'Url'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



285
286
287
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 285

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



126
127
128
129
130
131
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 126

def self.openapi_all_of
  [
  :'ConnectorBaseMessage',
  :'ConnectorHttpRequestAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



134
135
136
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 134

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 118

def self.openapi_nullable
  Set.new([
    :'header',
    :'url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 101

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'asset_target_moid' => :'String',
    :'body' => :'String',
    :'dial_timeout' => :'Integer',
    :'endpoint_moid' => :'String',
    :'header' => :'Object',
    :'internal' => :'Boolean',
    :'method' => :'String',
    :'timeout' => :'Integer',
    :'url' => :'ConnectorUrl'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      asset_target_moid == o.asset_target_moid &&
      body == o.body &&
      dial_timeout == o.dial_timeout &&
      endpoint_moid == o.endpoint_moid &&
      header == o.header &&
      internal == o.internal &&
      method == o.method &&
      timeout == o.timeout &&
      url == o.url && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 316

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 /\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 = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 387

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 292

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  ConnectorHttpRequest.openapi_types.each_pair do |key, type|
    if attributes[ConnectorHttpRequest.attribute_map[key]].nil? && ConnectorHttpRequest.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[ConnectorHttpRequest.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[ConnectorHttpRequest.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[ConnectorHttpRequest.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[ConnectorHttpRequest.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


272
273
274
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



278
279
280
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 278

def hash
  [class_id, object_type, asset_target_moid, body, dial_timeout, endpoint_moid, header, internal, method, timeout, url].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 207

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



363
364
365
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 363

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 369

def to_hash
  hash = super
  ConnectorHttpRequest.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = ConnectorHttpRequest.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 presentation of the object



357
358
359
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 357

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



222
223
224
225
226
227
228
229
230
 
# File 'lib/intersight_client/models/connector_http_request.rb', line 222

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["connector.HttpRequest"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["connector.HttpRequest"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end