Class: ArgoWorkflows::IoK8sApiCoreV1Event

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/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



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 117

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?(:'action')
    self.action = attributes[:'action']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

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



19
20
21
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 19

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



22
23
24
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 22

def api_version
  @api_version
end

#count ⇒ Object

The number of times this event has occurred.



25
26
27
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 25

def count
  @count
end

#event_time ⇒ Object

Time when this Event was first observed.



28
29
30
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 28

def event_time
  @event_time
end

#first_timestamp ⇒ Object

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)



31
32
33
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 31

def first_timestamp
  @first_timestamp
end

#involved_object ⇒ Object

The object that this event is about.



34
35
36
 
# File 'lib/argo_workflows/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/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 37

def kind
  @kind
end

#last_timestamp ⇒ Object

The time at which the most recent occurrence of this event was recorded.



40
41
42
 
# File 'lib/argo_workflows/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/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 43

def message
  @message
end

#metadata ⇒ Object

Standard object’s metadata. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata



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

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.



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

def reason
  @reason
end

#related ⇒ Object

Optional secondary object for more complex actions.



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

def related
  @related
end

#reporting_component ⇒ Object

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



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

def reporting_component
  @reporting_component
end

#reporting_instance ⇒ Object

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



58
59
60
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 58

def reporting_instance
  @reporting_instance
end

#series ⇒ Object

Data about the Event series this event represents or nil if it’s a singleton Event.



61
62
63
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 61

def series
  @series
end

#source ⇒ Object

The component reporting this event. Should be a short machine understandable string.



64
65
66
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 64

def source
  @source
end

#type ⇒ Object

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



67
68
69
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 67

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 70

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

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 93

def self.swagger_types
  {
    :'action' => :'String',
    :'api_version' => :'String',
    :'count' => :'Integer',
    :'event_time' => :'IoK8sApimachineryPkgApisMetaV1MicroTime',
    :'first_timestamp' => :'IoK8sApimachineryPkgApisMetaV1Time',
    :'involved_object' => :'IoK8sApiCoreV1ObjectReference',
    :'kind' => :'String',
    :'last_timestamp' => :'IoK8sApimachineryPkgApisMetaV1Time',
    :'message' => :'String',
    :'metadata' => :'IoK8sApimachineryPkgApisMetaV1ObjectMeta',
    :'reason' => :'String',
    :'related' => :'IoK8sApiCoreV1ObjectReference',
    :'reporting_component' => :'String',
    :'reporting_instance' => :'String',
    :'series' => :'IoK8sApiCoreV1EventSeries',
    :'source' => :'IoK8sApiCoreV1EventSource',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      api_version == o.api_version &&
      count == o.count &&
      event_time == o.event_time &&
      first_timestamp == o.first_timestamp &&
      involved_object == o.involved_object &&
      kind == o.kind &&
      last_timestamp == o.last_timestamp &&
      message == o.message &&
      metadata == o.metadata &&
      reason == o.reason &&
      related == o.related &&
      reporting_component == o.reporting_component &&
      reporting_instance == o.reporting_instance &&
      series == o.series &&
      source == o.source &&
      type == o.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



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
303
304
305
306
307
308
309
310
311
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 275

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 341

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 254

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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)
        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


241
242
243
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 247

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



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 194

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

  if @metadata.nil?
    invalid_properties.push('invalid value for "metadata", metadata 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



321
322
323
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 321

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



327
328
329
330
331
332
333
334
335
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 327

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



315
316
317
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 315

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



209
210
211
212
213
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_event.rb', line 209

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