Class: Kubernetes::V1beta1Webhook

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

Overview

Webhook 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 = {}) ⇒ V1beta1Webhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

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

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

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

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

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

  return unless attributes.key?(:sideEffects)

  self.side_effects = attributes[:sideEffects]
end

Instance Attribute Details

#client_config ⇒ Object

ClientConfig defines how to communicate with the hook. Required



19
20
21
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 19

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 Ignore.



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

def failure_policy
  @failure_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.



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

def name
  @name
end

#namespace_selector ⇒ Object

NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.



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

def namespace_selector
  @namespace_selector
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.



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

def rules
  @rules
end

#side_effects ⇒ Object

SideEffects states whether this webhookk has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change 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. Defaults to Unknown.



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

def side_effects
  @side_effects
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 37

def self.attribute_map
  {
    client_config: :clientConfig,
    failure_policy: :failurePolicy,
    name: :name,
    namespace_selector: :namespaceSelector,
    rules: :rules,
    side_effects: :sideEffects
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 49

def self.swagger_types
  {
    client_config: :AdmissionregistrationV1beta1WebhookClientConfig,
    failure_policy: :String,
    name: :String,
    namespace_selector: :V1LabelSelector,
    rules: :'Array<V1beta1RuleWithOperations>',
    side_effects: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 111

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

  self.class == other.class &&
    client_config == other.client_config &&
    failure_policy == other.failure_policy &&
    name == other.name &&
    namespace_selector == other.namespace_selector &&
    rules == other.rules &&
    side_effects == other.side_effects
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



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
191
192
193
194
195
196
197
198
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 162

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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 229

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



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

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


125
126
127
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 131

def hash
  [client_config, failure_policy, name, namespace_selector, rules, side_effects].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 89

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

  invalid_properties.push("invalid value for 'name', name cannot be nil.") if @name.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



208
209
210
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 208

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



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 214

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



202
203
204
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 202

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



102
103
104
105
106
107
 
# File 'lib/kubernetes/models/v1beta1_webhook.rb', line 102

def valid?
  return false if @client_config.nil?
  return false if @name.nil?

  true
end