Class: Kubernetes::V1MutatingWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_mutating_webhook.rb

Overview

MutatingWebhook describes an admission webhook and the resources and operations it applies to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1MutatingWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
167
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 101

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

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kubernetes::V1MutatingWebhook`. 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
  }

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#admission_review_versions ⇒ Object

AdmissionReviewVersions is an ordered list of preferred ‘AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.



20
21
22
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 20

def admission_review_versions
  @admission_review_versions
end

#client_config ⇒ Object

Returns the value of attribute client_config.



22
23
24
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 22

def client_config
  @client_config
end

#failure_policy ⇒ Object

FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.



25
26
27
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 25

def failure_policy
  @failure_policy
end

#match_conditions ⇒ Object

MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. 2. If ALL matchConditions evaluate to TRUE, the webhook is called. 3. If any matchCondition evaluates to an error (but none are FALSE): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the error is ignored and the webhook is skipped



28
29
30
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 28

def match_conditions
  @match_conditions
end

#match_policy ⇒ Object

matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included ‘apiGroups:, apiVersions:, resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:, apiVersions:, resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent"



31
32
33
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 31

def match_policy
  @match_policy
end

#name ⇒ Object

The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.



34
35
36
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 34

def name
  @name
end

#namespace_selector ⇒ Object

Returns the value of attribute namespace_selector.



36
37
38
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 36

def namespace_selector
  @namespace_selector
end

#object_selector ⇒ Object

Returns the value of attribute object_selector.



38
39
40
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 38

def object_selector
  @object_selector
end

#reinvocation_policy ⇒ Object

reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option must be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never".



41
42
43
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 41

def reinvocation_policy
  @reinvocation_policy
end

#rules ⇒ Object

Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.



44
45
46
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 44

def rules
  @rules
end

#side_effects ⇒ Object

SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.



47
48
49
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 47

def side_effects
  @side_effects
end

#timeout_seconds ⇒ Object

TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.



50
51
52
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 50

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 53

def self.attribute_map
  {
    :'admission_review_versions' => :'admissionReviewVersions',
    :'client_config' => :'clientConfig',
    :'failure_policy' => :'failurePolicy',
    :'match_conditions' => :'matchConditions',
    :'match_policy' => :'matchPolicy',
    :'name' => :'name',
    :'namespace_selector' => :'namespaceSelector',
    :'object_selector' => :'objectSelector',
    :'reinvocation_policy' => :'reinvocationPolicy',
    :'rules' => :'rules',
    :'side_effects' => :'sideEffects',
    :'timeout_seconds' => :'timeoutSeconds'
  }
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



236
237
238
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 76

def self.openapi_types
  {
    :'admission_review_versions' => :'Array<String>',
    :'client_config' => :'AdmissionregistrationV1WebhookClientConfig',
    :'failure_policy' => :'String',
    :'match_conditions' => :'Array<V1MatchCondition>',
    :'match_policy' => :'String',
    :'name' => :'String',
    :'namespace_selector' => :'V1LabelSelector',
    :'object_selector' => :'V1LabelSelector',
    :'reinvocation_policy' => :'String',
    :'rules' => :'Array<V1RuleWithOperations>',
    :'side_effects' => :'String',
    :'timeout_seconds' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      admission_review_versions == o.admission_review_versions &&
      client_config == o.client_config &&
      failure_policy == o.failure_policy &&
      match_conditions == o.match_conditions &&
      match_policy == o.match_policy &&
      name == o.name &&
      namespace_selector == o.namespace_selector &&
      object_selector == o.object_selector &&
      reinvocation_policy == o.reinvocation_policy &&
      rules == o.rules &&
      side_effects == o.side_effects &&
      timeout_seconds == o.timeout_seconds
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



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
303
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 266

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 337

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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)
        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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 229

def hash
  [admission_review_versions, client_config, failure_policy, match_conditions, match_policy, name, namespace_selector, object_selector, reinvocation_policy, rules, side_effects, timeout_seconds].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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 171

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

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

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

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



313
314
315
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 319

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



307
308
309
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 307

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



194
195
196
197
198
199
200
 
# File 'lib/kubernetes/models/v1_mutating_webhook.rb', line 194

def valid?
  return false if @admission_review_versions.nil?
  return false if @client_config.nil?
  return false if @name.nil?
  return false if @side_effects.nil?
  true
end