Class: VSphereAutomation::VAPI::VapiStdErrorsNotAllowedInCurrentState

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VapiStdErrorsNotAllowedInCurrentState

Initializes the object

Parameters:

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

    Model attributes in the form of hash



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 38

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'data')
    self.data = attributes[:'data']
  end
end

Instance Attribute Details

#data ⇒ Object

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. <p> Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. vapi.std.DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.



18
19
20
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 18

def data
  @data
end

#messages ⇒ Object

Stack of one or more localizable messages for human error consumers. <p> The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.



15
16
17
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 15

def messages
  @messages
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 21

def self.attribute_map
  {
    :'messages' => :'messages',
    :'data' => :'data'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



29
30
31
32
33
34
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 29

def self.openapi_types
  {
    :'messages' => :'Array<VapiStdLocalizableMessage>',
    :'data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



75
76
77
78
79
80
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 75

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages == o.messages &&
      data == o.data
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



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
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 118

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN, :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
    temp_model = VSphereAutomation::VAPI.const_get(type).new
    temp_model.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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 184

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 97

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


84
85
86
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 84

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 90

def hash
  [messages, data].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



57
58
59
60
61
62
63
64
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 57

def list_invalid_properties
  invalid_properties = Array.new
  if @messages.nil?
    invalid_properties.push('invalid value for "messages", messages 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



164
165
166
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 164

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



170
171
172
173
174
175
176
177
178
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 170

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



158
159
160
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 158

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



68
69
70
71
 
# File 'lib/vsphere-automation-vapi/models/vapi_std_errors_not_allowed_in_current_state.rb', line 68

def valid?
  return false if @messages.nil?
  true
end