Class: IntersightClient::WorkflowUiInputFilter

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

Overview

A cascade filter enables the definition or extension of an optional filter for Intersight APIs, to narrow down the search results. This can be defined for workflow inputs only.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowUiInputFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
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
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 109

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

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

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

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

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

Instance Attribute Details

#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_ui_input_filter.rb', line 20

def class_id
  @class_id
end

#filters ⇒ Object

Returns the value of attribute filters.



25
26
27
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 25

def filters
  @filters
end

#name ⇒ Object

Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to seperate each section of the name like "StorageConfig.Volume" where ‘StorageConfig’ is an input name and ‘Volume’ is a sub property defined through custom data type definition.



28
29
30
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 28

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

def object_type
  @object_type
end

#user_help_message ⇒ Object

Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.



31
32
33
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 31

def user_help_message
  @user_help_message
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)



72
73
74
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 72

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)



67
68
69
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 67

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.



56
57
58
59
60
61
62
63
64
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 56

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'filters' => :'Filters',
    :'name' => :'Name',
    :'user_help_message' => :'UserHelpMessage'
  }
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



267
268
269
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 267

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



95
96
97
98
99
100
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 95

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



103
104
105
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 103

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
92
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 77

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'filters' => :'Array<String>',
    :'name' => :'String',
    :'user_help_message' => :'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
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.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 &&
      filters == o.filters &&
      name == o.name &&
      user_help_message == o.user_help_message && super(o)
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



298
299
300
301
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
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 298

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 260

def hash
  [class_id, object_type, filters, name, user_help_message].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



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

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

  if !@filters.nil? && @filters.length > 1
    invalid_properties.push('invalid value for "filters", number of items must be less than or equal to 1.')
  end

  if !@filters.nil? && @filters.length < 1
    invalid_properties.push('invalid value for "filters", number of items must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9]+([a-zA-Z0-9\-_.]*[a-zA-Z0-9])*$/)
  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



345
346
347
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 351

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



339
340
341
 
# File 'lib/intersight_client/models/workflow_ui_input_filter.rb', line 339

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["workflow.UiInputFilter"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["workflow.UiInputFilter"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@filters.nil? && @filters.length > 1
  return false if !@filters.nil? && @filters.length < 1
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9]+([a-zA-Z0-9\-_.]*[a-zA-Z0-9])*$/)
  true && super
end