Class: IntersightClient::MetaRelationshipDefinitionAllOf

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

Overview

Definition of the list of properties defined in ‘meta.RelationshipDefinition’, 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 = {}) ⇒ MetaRelationshipDefinitionAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 121

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_access ⇒ Object

API access definition for this relationship. * ‘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_relationship_definition_all_of.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_relationship_definition_all_of.rb', line 20

def class_id
  @class_id
end

#collection ⇒ Object

Specifies whether the relationship is a collection.



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

def collection
  @collection
end

#export ⇒ Object

When turned off, the peer MO is not exported when the local MO is exported.



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

def export
  @export
end

#export_with_peer ⇒ Object

When turned on, the local MO is exported when the peer is exported.



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

def export_with_peer
  @export_with_peer
end

#name ⇒ Object

The name of the relationship.



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

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

def object_type
  @object_type
end

#peer_rel_name ⇒ Object

Name of relationship in peer managed object.



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

def peer_rel_name
  @peer_rel_name
end

#peer_sync ⇒ Object

When turned on, peer MO corresponding to the reference provided in relation is updated with a reference to the current MO.



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

def peer_sync
  @peer_sync
end

#type ⇒ Object

Fully qualified type of the peer managed object.



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

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



93
94
95
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 72

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'api_access' => :'ApiAccess',
    :'collection' => :'Collection',
    :'export' => :'Export',
    :'export_with_peer' => :'ExportWithPeer',
    :'name' => :'Name',
    :'peer_rel_name' => :'PeerRelName',
    :'peer_sync' => :'PeerSync',
    :'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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 98

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'api_access' => :'String',
    :'collection' => :'Boolean',
    :'export' => :'Boolean',
    :'export_with_peer' => :'Boolean',
    :'name' => :'String',
    :'peer_rel_name' => :'String',
    :'peer_sync' => :'Boolean',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 242

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 &&
      collection == o.collection &&
      export == o.export &&
      export_with_peer == o.export_with_peer &&
      name == o.name &&
      peer_rel_name == o.peer_rel_name &&
      peer_sync == o.peer_sync &&
      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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 302

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



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

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 279

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 265

def hash
  [class_id, object_type, api_access, collection, export, export_with_peer, name, peer_rel_name, peer_sync, 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



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 183

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

  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



349
350
351
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 349

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 355

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



343
344
345
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 343

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



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/intersight_client/models/meta_relationship_definition_all_of.rb', line 198

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["meta.RelationshipDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["meta.RelationshipDefinition"])
  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)
  true
end