Class: IntersightClient::ContentBaseParameterAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/models/content_base_parameter_all_of.rb

Overview

Definition of the list of properties defined in ‘content.BaseParameter’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentBaseParameterAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::ContentBaseParameterAllOf` 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
  }

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

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

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

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

  if attributes.key?(:'item_type')
    self.item_type = attributes[:'item_type']
  else
    self.item_type = 'simple'
  end

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'simple'
  end
end

Instance Attribute Details

#accept_single_value ⇒ Object

The flag that allows single values in content to be extracted as a single element collection in case the parameter is of Collection type. This flag is applicable for parameters of type Collection only.



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

def accept_single_value
  @accept_single_value
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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#complex_type ⇒ Object

The name of the complex type definition in case this is a complex parameter. The content.Grammar object must have a complex type, content.ComplexType, defined with the specified name in types collection property.



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

def complex_type
  @complex_type
end

#item_type ⇒ Object

The type of the collection item in case this is a collection parameter. * simple - The parameter value to be extracted is of the type simple. All the common scalar typessuch as int, bool, string, etc are represented by the simple enum. * string - The parameter value to be extracted is of the string type. * integer - The parameter value to be extracted is of the number type. * float - The parameter value to be extracted is of the float number type. * boolean - The parameter value to be extracted is of the boolean type. * json - The parameter values to be extracted is of the generic JSON literal. JSON type is applicable only if the content to be parsed is of JSON type. * complex - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters. * collection - The parameter value to be extracted is a collection parameter whose item typeshall be either simple type or complex type.



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

def item_type
  @item_type
end

#name ⇒ Object

The name of the parameter.



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

def name
  @name
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#path ⇒ Object

The content specific path information that identifies the parameter value within the content. The value is usually a XPath or JSONPath or a regular expression in case of text content.



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

def path
  @path
end

#secure ⇒ Object

The flag indicates if the extracted value is secure. This flag is applicable for parameters of type String only.



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

def secure
  @secure
end

#type ⇒ Object

The type of the parameter. Accepted values are simple, complex, collection. * simple - The parameter value to be extracted is of the type simple. All the common scalar typessuch as int, bool, string, etc are represented by the simple enum. * string - The parameter value to be extracted is of the string type. * integer - The parameter value to be extracted is of the number type. * float - The parameter value to be extracted is of the float number type. * boolean - The parameter value to be extracted is of the boolean type. * json - The parameter values to be extracted is of the generic JSON literal. JSON type is applicable only if the content to be parsed is of JSON type. * complex - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters. * collection - The parameter value to be extracted is a collection parameter whose item typeshall be either simple type or complex type.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



89
90
91
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 89

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'accept_single_value' => :'AcceptSingleValue',
    :'complex_type' => :'ComplexType',
    :'item_type' => :'ItemType',
    :'name' => :'Name',
    :'path' => :'Path',
    :'secure' => :'Secure',
    :'type' => :'Type'
  }
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



289
290
291
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 289

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 109

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'accept_single_value' => :'Boolean',
    :'complex_type' => :'String',
    :'item_type' => :'String',
    :'name' => :'String',
    :'path' => :'String',
    :'secure' => :'Boolean',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      accept_single_value == o.accept_single_value &&
      complex_type == o.complex_type &&
      item_type == o.item_type &&
      name == o.name &&
      path == o.path &&
      secure == o.secure &&
      type == o.type
end

#_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



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
354
355
356
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 319

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 390

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 296

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 282

def hash
  [class_id, object_type, accept_single_value, complex_type, item_type, name, path, secure, type].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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  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

  pattern = Regexp.new(/^[a-zA-Z0-9_.:-]{1,64}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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



366
367
368
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 372

def to_hash
  hash = {}
  ContentBaseParameterAllOf.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = ContentBaseParameterAllOf.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



360
361
362
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 360

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/intersight_client/models/content_base_parameter_all_of.rb', line 192

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["content.Parameter", "content.TextParameter"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["content.Parameter", "content.TextParameter"])
  return false unless object_type_validator.valid?(@object_type)
  item_type_validator = EnumAttributeValidator.new('String', ["simple", "string", "integer", "float", "boolean", "json", "complex", "collection"])
  return false unless item_type_validator.valid?(@item_type)
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9_.:-]{1,64}$/)
  type_validator = EnumAttributeValidator.new('String', ["simple", "string", "integer", "float", "boolean", "json", "complex", "collection"])
  return false unless type_validator.valid?(@type)
  true
end