Class: Zilla::IoK8sApimachineryPkgApisMetaV1ListMeta

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb

Overview

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of ListMeta.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApimachineryPkgApisMetaV1ListMeta

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 63

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApimachineryPkgApisMetaV1ListMeta` initialize method'
  end

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

    h[k.to_sym] = v
  end

  self.continue = attributes[:continue] if attributes.key?(:continue)

  self.remaining_item_count = attributes[:remaining_item_count] if attributes.key?(:remaining_item_count)

  self.resource_version = attributes[:resource_version] if attributes.key?(:resource_version)

  return unless attributes.key?(:self_link)

  self.self_link = attributes[:self_link]
end

Instance Attribute Details

#continue ⇒ Object

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.



20
21
22
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 20

def continue
  @continue
end

#remaining_item_count ⇒ Object

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.



23
24
25
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 23

def remaining_item_count
  @remaining_item_count
end

#resource_version ⇒ Object

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency



26
27
28
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 26

def resource_version
  @resource_version
end

#self_link ⇒ Object

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.



29
30
31
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 29

def self_link
  @self_link
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 32

def self.attribute_map
  {
    continue: :continue,
    remaining_item_count: :remainingItemCount,
    resource_version: :resourceVersion,
    self_link: :selfLink
  }
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



129
130
131
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 129

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 47

def self.openapi_types
  {
    continue: :String,
    remaining_item_count: :Integer,
    resource_version: :String,
    self_link: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
112
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 104

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    continue == other.continue &&
    remaining_item_count == other.remaining_item_count &&
    resource_version == other.resource_version &&
    self_link == other.self_link
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



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
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 163

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 = Zilla.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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 234

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 136

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


116
117
118
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



122
123
124
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 122

def hash
  [continue, remaining_item_count, resource_version, self_link].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



92
93
94
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 92

def list_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



210
211
212
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 210

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 216

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



204
205
206
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 204

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



98
99
100
 
# File 'lib/zilla/models/io_k8s_apimachinery_pkg_apis_meta_v1_list_meta.rb', line 98

def valid?
  true
end