Class: Kubernetes::V1DeleteOptions

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

Overview

DeleteOptions may be provided when deleting an API object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1DeleteOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 67

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

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

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

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

  if attributes.key?(:gracePeriodSeconds)
    self.grace_period_seconds = attributes[:gracePeriodSeconds]
  end

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

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

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

  return unless attributes.key?(:propagationPolicy)

  self.propagation_policy = attributes[:propagationPolicy]
end

Instance Attribute Details

#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/api-conventions.md#resources



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

def api_version
  @api_version
end

#dry_run ⇒ Object

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed



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

def dry_run
  @dry_run
end

#grace_period_seconds ⇒ Object

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.



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

def grace_period_seconds
  @grace_period_seconds
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/api-conventions.md#types-kinds



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

def kind
  @kind
end

#orphan_dependents ⇒ Object

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.



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

def orphan_dependents
  @orphan_dependents
end

#preconditions ⇒ Object

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.



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

def preconditions
  @preconditions
end

#propagation_policy ⇒ Object

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.



37
38
39
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 37

def propagation_policy
  @propagation_policy
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 40

def self.attribute_map
  {
    api_version: :apiVersion,
    dry_run: :dryRun,
    grace_period_seconds: :gracePeriodSeconds,
    kind: :kind,
    orphan_dependents: :orphanDependents,
    preconditions: :preconditions,
    propagation_policy: :propagationPolicy
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 53

def self.swagger_types
  {
    api_version: :String,
    dry_run: :'Array<String>',
    grace_period_seconds: :Integer,
    kind: :String,
    orphan_dependents: :BOOLEAN,
    preconditions: :V1Preconditions,
    propagation_policy: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 108

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

  self.class == other.class &&
    api_version == other.api_version &&
    dry_run == other.dry_run &&
    grace_period_seconds == other.grace_period_seconds &&
    kind == other.kind &&
    orphan_dependents == other.orphan_dependents &&
    preconditions == other.preconditions &&
    propagation_policy == other.propagation_policy
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



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

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



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

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



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

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


123
124
125
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
132
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 129

def hash
  [api_version, dry_run, grace_period_seconds, kind, orphan_dependents, preconditions,
   propagation_policy].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



96
97
98
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 96

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



207
208
209
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 207

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



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

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



201
202
203
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 201

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
 
# File 'lib/kubernetes/models/v1_delete_options.rb', line 102

def valid?
  true
end