Class: Zilla::IoK8sApiCoreV1Event

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

Overview

Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1Event

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 115

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiCoreV1Event` 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::IoK8sApiCoreV1Event`. 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.action = attributes[:action] if attributes.key?(:action)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:type)

  self.type = attributes[:type]
end

Instance Attribute Details

#action ⇒ Object

What action was taken/failed regarding to the Regarding object.



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

def action
  @action
end

#api_version ⇒ Object

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources



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

def api_version
  @api_version
end

#count ⇒ Object

The number of times this event has occurred.



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

def count
  @count
end

#event_time ⇒ Object

MicroTime is version of Time with microsecond level precision.



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

def event_time
  @event_time
end

#first_timestamp ⇒ Object

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.



32
33
34
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 32

def first_timestamp
  @first_timestamp
end

#involved_object ⇒ Object

Returns the value of attribute involved_object.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 34

def involved_object
  @involved_object
end

#kind ⇒ Object

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds



37
38
39
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 37

def kind
  @kind
end

#last_timestamp ⇒ Object

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.



40
41
42
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 40

def last_timestamp
  @last_timestamp
end

#message ⇒ Object

A human-readable description of the status of this operation.



43
44
45
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 43

def message
  @message
end

#metadata ⇒ Object

Returns the value of attribute metadata.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 34

def metadata
  @metadata
end

#reason ⇒ Object

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.



46
47
48
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 46

def reason
  @reason
end

#related ⇒ Object

Returns the value of attribute related.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 34

def related
  @related
end

#reporting_component ⇒ Object

Name of the controller that emitted this Event, e.g. ‘kubernetes.io/kubelet`.



49
50
51
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 49

def reporting_component
  @reporting_component
end

#reporting_instance ⇒ Object

ID of the controller instance, e.g. ‘kubelet-xyzf`.



52
53
54
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 52

def reporting_instance
  @reporting_instance
end

#series ⇒ Object

Returns the value of attribute series.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 34

def series
  @series
end

#source ⇒ Object

Returns the value of attribute source.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 34

def source
  @source
end

#type ⇒ Object

Type of this event (Normal, Warning), new types could be added in the future



55
56
57
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 55

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 58

def self.attribute_map
  {
    action: :action,
    api_version: :apiVersion,
    count: :count,
    event_time: :eventTime,
    first_timestamp: :firstTimestamp,
    involved_object: :involvedObject,
    kind: :kind,
    last_timestamp: :lastTimestamp,
    message: :message,
    metadata: :metadata,
    reason: :reason,
    related: :related,
    reporting_component: :reportingComponent,
    reporting_instance: :reportingInstance,
    series: :series,
    source: :source,
    type: :type
  }
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



231
232
233
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 231

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 86

def self.openapi_types
  {
    action: :String,
    api_version: :String,
    count: :Integer,
    event_time: :Time,
    first_timestamp: :Time,
    involved_object: :IoK8sApiCoreV1ObjectReference,
    kind: :String,
    last_timestamp: :Time,
    message: :String,
    metadata: :IoK8sApimachineryPkgApisMetaV1ObjectMeta,
    reason: :String,
    related: :IoK8sApiCoreV1ObjectReference,
    reporting_component: :String,
    reporting_instance: :String,
    series: :IoK8sApiCoreV1EventSeries,
    source: :IoK8sApiCoreV1EventSource,
    type: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 192

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

  self.class == other.class &&
    action == other.action &&
    api_version == other.api_version &&
    count == other.count &&
    event_time == other.event_time &&
    first_timestamp == other.first_timestamp &&
    involved_object == other.involved_object &&
    kind == other.kind &&
    last_timestamp == other.last_timestamp &&
    message == other.message &&
    metadata == other.metadata &&
    reason == other.reason &&
    related == other.related &&
    reporting_component == other.reporting_component &&
    reporting_instance == other.reporting_instance &&
    series == other.series &&
    source == other.source &&
    type == other.type
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 265

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 336

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 238

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


217
218
219
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
226
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 223

def hash
  [action, api_version, count, event_time, first_timestamp, involved_object, kind, last_timestamp, message,
   metadata, reason, related, reporting_component, reporting_instance, series, source, type].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



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 170

def list_invalid_properties
  invalid_properties = []
  if @involved_object.nil?
    invalid_properties.push('invalid value for "involved_object", involved_object cannot be nil.')
  end

  invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') if @metadata.nil?

  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



312
313
314
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 318

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



306
307
308
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 306

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



183
184
185
186
187
188
 
# File 'lib/zilla/models/io_k8s_api_core_v1_event.rb', line 183

def valid?
  return false if @involved_object.nil?
  return false if @metadata.nil?

  true
end