Class: IntersightClient::WorkflowCustomDataTypeDefinitionAllOf

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

Overview

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

Initializes the object



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
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 124

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

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

  if attributes.key?(:'composite_type')
    self.composite_type = attributes[:'composite_type']
  else
    self.composite_type = false
  end

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

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

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

  if attributes.key?(:'parameter_set')
    if (value = attributes[:'parameter_set']).is_a?(Array)
      self.parameter_set = value
    end
  end

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

  if attributes.key?(:'type_definition')
    if (value = attributes[:'type_definition']).is_a?(Array)
      self.type_definition = value
    end
  end

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

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

Instance Attribute Details

#catalog ⇒ Object

Returns the value of attribute catalog.



43
44
45
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 43

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

def class_id
  @class_id
end

#cloned_from ⇒ Object

Returns the value of attribute cloned_from.



45
46
47
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 45

def cloned_from
  @cloned_from
end

#composite_type ⇒ Object

When true this data type definition is a collection of type definitions to represent composite data like JSON.



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

def composite_type
  @composite_type
end

#description ⇒ Object

A human-friendly description of this custom data type indicating it’s domain and usage.



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

def description
  @description
end

#label ⇒ Object

A user friendly short name to identify the custom data type definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote (‘), or an underscore (_) and must be at least 2 characters.



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

def label
  @label
end

#name ⇒ Object

The name of custom data type definition. The valid name can contain lower case and upper case alphabetic characters, digits and special characters ‘-’ and ‘_’.



35
36
37
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_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.



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

def object_type
  @object_type
end

#parameter_set ⇒ Object

Returns the value of attribute parameter_set.



37
38
39
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 37

def parameter_set
  @parameter_set
end

#properties ⇒ Object

Returns the value of attribute properties.



39
40
41
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 39

def properties
  @properties
end

#type_definition ⇒ Object

Returns the value of attribute type_definition.



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

def type_definition
  @type_definition
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'composite_type' => :'CompositeType',
    :'description' => :'Description',
    :'label' => :'Label',
    :'name' => :'Name',
    :'parameter_set' => :'ParameterSet',
    :'properties' => :'Properties',
    :'type_definition' => :'TypeDefinition',
    :'catalog' => :'Catalog',
    :'cloned_from' => :'ClonedFrom'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



306
307
308
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 306

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
118
119
120
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 114

def self.openapi_nullable
  Set.new([
    :'parameter_set',
    :'properties',
    :'type_definition',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'composite_type' => :'Boolean',
    :'description' => :'String',
    :'label' => :'String',
    :'name' => :'String',
    :'parameter_set' => :'Array<WorkflowParameterSet>',
    :'properties' => :'WorkflowCustomDataTypeProperties',
    :'type_definition' => :'Array<WorkflowBaseDataType>',
    :'catalog' => :'WorkflowCatalogRelationship',
    :'cloned_from' => :'WorkflowCustomDataTypeDefinitionRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      composite_type == o.composite_type &&
      description == o.description &&
      label == o.label &&
      name == o.name &&
      parameter_set == o.parameter_set &&
      properties == o.properties &&
      type_definition == o.type_definition &&
      catalog == o.catalog &&
      cloned_from == o.cloned_from
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 407

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 313

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


293
294
295
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



299
300
301
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 299

def hash
  [class_id, object_type, composite_type, description, label, name, parameter_set, properties, type_definition, catalog, cloned_from].hash
end

#list_invalid_properties ⇒ Object

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 194

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]+[\sa-zA-Z0-9_'.:-]{1,92}$/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  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)



383
384
385
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 383

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



377
378
379
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 377

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/intersight_client/models/workflow_custom_data_type_definition_all_of.rb', line 219

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.CustomDataTypeDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.CustomDataTypeDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@label.nil? && @label !~ Regexp.new(/^[a-zA-Z0-9]+[\sa-zA-Z0-9_'.:-]{1,92}$/)
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9_-]{1,64}$/)
  true
end