Class: Kubevirt::V1beta1VirtualMachineRestoreSpec

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb

Overview

VirtualMachineRestoreSpec is the spec for a VirtualMachineRestore resource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ V1beta1VirtualMachineRestoreSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 79

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kubevirt::V1beta1VirtualMachineRestoreSpec`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'target')
    self.target = attributes[:'target']
  else
    self.target = nil
  end

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

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

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

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

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

Instance Attribute Details

#patchesObject

If the target for the restore does not exist, it will be created. Patches holds JSON patches that would be applied to the target manifest before it’s created. Patches should fit the target’s Kind. Example for a patch: "replace", "path": "/metadata/name", "value": "new-vm-name"



20
21
22
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 20

def patches
  @patches
end

#targetObject

Returns the value of attribute target.



22
23
24
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 22

def target
  @target
end

#target_readiness_policyObject

Returns the value of attribute target_readiness_policy.



24
25
26
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 24

def target_readiness_policy
  @target_readiness_policy
end

#virtual_machine_snapshot_nameObject

Returns the value of attribute virtual_machine_snapshot_name.



26
27
28
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 26

def virtual_machine_snapshot_name
  @virtual_machine_snapshot_name
end

#volume_ownership_policyObject

Returns the value of attribute volume_ownership_policy.



28
29
30
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 28

def volume_ownership_policy
  @volume_ownership_policy
end

#volume_restore_overridesObject

VolumeRestoreOverrides gives the option to change properties of each restored volume For example, specifying the name of the restored volume, or adding labels/annotations to it



31
32
33
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 31

def volume_restore_overrides
  @volume_restore_overrides
end

#volume_restore_policyObject

Returns the value of attribute volume_restore_policy.



33
34
35
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 33

def volume_restore_policy
  @volume_restore_policy
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



49
50
51
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



54
55
56
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'patches' => :'patches',
    :'target' => :'target',
    :'target_readiness_policy' => :'targetReadinessPolicy',
    :'virtual_machine_snapshot_name' => :'virtualMachineSnapshotName',
    :'volume_ownership_policy' => :'volumeOwnershipPolicy',
    :'volume_restore_overrides' => :'volumeRestoreOverrides',
    :'volume_restore_policy' => :'volumeRestorePolicy'
  }
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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 204

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



72
73
74
75
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 72

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

.openapi_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 59

def self.openapi_types
  {
    :'patches' => :'Array<String>',
    :'target' => :'K8sIoApiCoreV1TypedLocalObjectReference',
    :'target_readiness_policy' => :'String',
    :'virtual_machine_snapshot_name' => :'String',
    :'volume_ownership_policy' => :'String',
    :'volume_restore_overrides' => :'Array<V1beta1VolumeRestoreOverride>',
    :'volume_restore_policy' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



177
178
179
180
181
182
183
184
185
186
187
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      patches == o.patches &&
      target == o.target &&
      target_readiness_policy == o.target_readiness_policy &&
      virtual_machine_snapshot_name == o.virtual_machine_snapshot_name &&
      volume_ownership_policy == o.volume_ownership_policy &&
      volume_restore_overrides == o.volume_restore_overrides &&
      volume_restore_policy == o.volume_restore_policy
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 191

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



197
198
199
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 197

def hash
  [patches, target, target_readiness_policy, virtual_machine_snapshot_name, volume_ownership_policy, volume_restore_overrides, volume_restore_policy].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @target.nil?
    invalid_properties.push('invalid value for "target", target cannot be nil.')
  end

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 226

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

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



148
149
150
151
152
153
# File 'lib/kubevirt/models/v1beta1_virtual_machine_restore_spec.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @target.nil?
  return false if @virtual_machine_snapshot_name.nil?
  true
end