Class: IntersightClient::MetaPropDefinition

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/meta_prop_definition.rb

Overview

Definitions for the properties in a meta.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetaPropDefinition

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
204
205
206
207
208
209
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 140

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

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

  if attributes.key?(:'api_access')
    self.api_access = attributes[:'api_access']
  else
    self.api_access = 'NoAccess'
  end

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

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

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

  if attributes.key?(:'kind')
    self.kind = attributes[:'kind']
  else
    self.kind = 'Unknown'
  end

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

  if attributes.key?(:'op_security')
    self.op_security = attributes[:'op_security']
  else
    self.op_security = 'ClearText'
  end

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

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

Instance Attribute Details

#api_access ⇒ Object

API access control for the property. Examples are NoAccess, ReadOnly, CreateOnly etc. * ‘NoAccess` - The property is not accessible from the API. * `ReadOnly` - The value of the property is read-only.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa ReadOnly property. * `CreateOnly` - The value of the property can be set when the REST resource is created. It cannot be changed after object creation.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa CreateOnly property.CreateOnly properties are returned in the response body of HTTP GET requests. * `ReadWrite` - The property has read/write access. * `WriteOnly` - The value of the property can be set but it is never returned in the response body of supported HTTP methods.This settings is used for sensitive properties such as passwords. * `ReadOnCreate` - The value of the property is returned in the HTTP POST response body when the REST resource is created.The property is not writeable and cannot be queried through a GET request after the resource has been created.



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

def api_access
  @api_access
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/meta_prop_definition.rb', line 20

def class_id
  @class_id
end

#default ⇒ Object

The default value of the property. Not applicable when IsComplexType is True.



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

def default
  @default
end

#is_collection ⇒ Object

Indicates whether the property is a collection (i.e. a JSON array), otherwise it is a single value.



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

def is_collection
  @is_collection
end

#is_complex_type ⇒ Object

Indicates whether the property is a complex type, otherwise it is a basic scalar type.



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

def is_complex_type
  @is_complex_type
end

#kind ⇒ Object

The kind of the property. * ‘Unknown` - The property kind is unknown. * `Boolean` - The ’Boolean’ kind of property. * ‘String` - The ’String’ kind of property. * ‘Integer` - The ’Integer’ kind of property. * ‘Int32` - The ’Int32’ kind of property. * ‘Int64` - The ’Int64’ kind of property. * ‘Float` - The ’Float’ kind of property. * ‘Double` - The ’Double’ kind of property. * ‘Date` - The ’Date’ kind of property. * ‘Duration` - The ’Duration’ kind of property. * ‘Time` - The ’Time’ kind of property. * ‘Json` - The ’JSON’ kind of property. * ‘Binary` - The ’Binary’ kind of property. * ‘EnumString` - The ’EnumString’ kind of property. * ‘EnumInteger` - The ’EnumInteger’ kind of property. * ‘ComplexType` - The ’ComplexType’ kind of property.



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

def kind
  @kind
end

#name ⇒ Object

The name of the property.



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

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.



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

def object_type
  @object_type
end

#op_security ⇒ Object

The data-at-rest security protection applied to this property when a Managed Object is persisted. For example, Encrypted or Cleartext. * ‘ClearText` - Data at rest is not encrypted using account specific keys.Note that data is always protected using volume encryption. ClearText propertiesare queryable and searchable. * `Encrypted` - The value of the property is encrypted with account-specific cryptographic keys.This setting is used for properties that contain sensitive data. Encrypted propertiesare not queryable and searchable. * `Pbkdf2` - The value of the property is hashed using the pbkdf2 key derivation functions thattakes a password, a salt, and a cost factor as inputs then generates a password hash.Its purpose is to make each password guessing trial by an attacker who has obtaineda password hash file expensive and therefore the cost of a guessing attack high or prohibitive. * `Bcrypt` - The value of the property is hashed using the bcrypt key derivation function. * `Sha512crypt` - The value of the property is hashed using the sha512crypt key derivation function. * `Argon2id` - The value of the property is hashed using the argon2id key derivation function.



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

def op_security
  @op_security
end

#search_weight ⇒ Object

Enables the property to be searchable from global search. A value of 0 means this property is not globally searchable.



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

def search_weight
  @search_weight
end

#type ⇒ Object

The type of the property. In case of collection properties the type is that of individual elements.



50
51
52
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 50

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, including the ones defined in its parent(s)



97
98
99
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 97

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)



92
93
94
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 92

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'api_access' => :'ApiAccess',
    :'default' => :'Default',
    :'is_collection' => :'IsCollection',
    :'is_complex_type' => :'IsComplexType',
    :'kind' => :'Kind',
    :'name' => :'Name',
    :'op_security' => :'OpSecurity',
    :'search_weight' => :'SearchWeight',
    :'type' => :'Type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



327
328
329
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 327

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/meta_prop_definition.rb', line 126

def self.openapi_all_of
  [
  :'MetaPropDefinitionAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'api_access' => :'String',
    :'default' => :'Object',
    :'is_collection' => :'Boolean',
    :'is_complex_type' => :'Boolean',
    :'kind' => :'String',
    :'name' => :'String',
    :'op_security' => :'String',
    :'search_weight' => :'Float',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      api_access == o.api_access &&
      default == o.default &&
      is_collection == o.is_collection &&
      is_complex_type == o.is_complex_type &&
      kind == o.kind &&
      name == o.name &&
      op_security == o.op_security &&
      search_weight == o.search_weight &&
      type == o.type && 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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 358

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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 429

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 334

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


314
315
316
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



320
321
322
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 320

def hash
  [class_id, object_type, api_access, default, is_collection, is_complex_type, kind, name, op_security, search_weight, 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



213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 213

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



405
406
407
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 405

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 411

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



399
400
401
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 399

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/intersight_client/models/meta_prop_definition.rb', line 228

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["meta.PropDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["meta.PropDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  api_access_validator = EnumAttributeValidator.new('String', ["NoAccess", "ReadOnly", "CreateOnly", "ReadWrite", "WriteOnly", "ReadOnCreate"])
  return false unless api_access_validator.valid?(@api_access)
  kind_validator = EnumAttributeValidator.new('String', ["Unknown", "Boolean", "String", "Integer", "Int32", "Int64", "Float", "Double", "Date", "Duration", "Time", "Json", "Binary", "EnumString", "EnumInteger", "ComplexType"])
  return false unless kind_validator.valid?(@kind)
  op_security_validator = EnumAttributeValidator.new('String', ["ClearText", "Encrypted", "Pbkdf2", "Bcrypt", "Sha512crypt", "Argon2id"])
  return false unless op_security_validator.valid?(@op_security)
  true && super
end