Class: NutanixClustermgmt::CommonV10ResponseApiResponseMetadata

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb

Overview

The metadata associated with an API response. This value is always present and minimally contains the self-link for the API request that produced this response. It also contains pagination data for the paginated requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CommonV10ResponseApiResponseMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NutanixClustermgmt::CommonV10ResponseApiResponseMetadata` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `NutanixClustermgmt::CommonV10ResponseApiResponseMetadata`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

Instance Attribute Details

#extra_info ⇒ Object

An array of entity-specific metadata



32
33
34
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 32

def extra_info
  @extra_info
end

#flags ⇒ Object

An array of flags that may indicate the status of the response. For example, a flag with the name ‘isPaginated’ and value ‘false’, indicates that the response is not paginated.



20
21
22
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 20

def flags
  @flags
end

#links ⇒ Object

An array of HATEOAS style links for the response that may also include pagination links for list operations.



23
24
25
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 23

def links
  @links
end

#messages ⇒ Object

Information, Warning or Error messages that might provide additional contextual information related to the operation.



29
30
31
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 29

def messages
  @messages
end

#total_available_results ⇒ Object

The total number of entities that are available on the server for this type.



26
27
28
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 26

def total_available_results
  @total_available_results
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 35

def self.attribute_map
  {
    :'flags' => :'flags',
    :'links' => :'links',
    :'total_available_results' => :'totalAvailableResults',
    :'messages' => :'messages',
    :'extra_info' => :'extraInfo'
  }
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 271

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'flags' => :'Array<CommonV10ConfigFlag>',
    :'links' => :'Array<CommonV10ResponseApiLink>',
    :'total_available_results' => :'Integer',
    :'messages' => :'Array<CommonV10ConfigMessage>',
    :'extra_info' => :'Array<CommonV10ConfigKVPair>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flags == o.flags &&
      links == o.links &&
      total_available_results == o.total_available_results &&
      messages == o.messages &&
      extra_info == o.extra_info
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



264
265
266
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 264

def hash
  [flags, links, total_available_results, messages, extra_info].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



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
155
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@flags.nil? && @flags.length > 20
    invalid_properties.push('invalid value for "flags", number of items must be less than or equal to 20.')
  end

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

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 293

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/nutanix_clustermgmt/models/common_v10_response_api_response_metadata.rb', line 159

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@flags.nil? && @flags.length > 20
  return false if !@flags.nil? && @flags.length < 0
  return false if !@links.nil? && @links.length > 20
  return false if !@links.nil? && @links.length < 0
  return false if !@messages.nil? && @messages.length > 20
  return false if !@messages.nil? && @messages.length < 0
  return false if !@extra_info.nil? && @extra_info.length > 20
  return false if !@extra_info.nil? && @extra_info.length < 0
  true
end