comet_backup_ruby_sdk 2.40.0 → 2.42.0

data/lib/comet/models/partition_conflict.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # PartitionConflict is a typed class wrapper around the underlying Comet Server API data structure.
+  class PartitionConflict
+
+    # @type [String] partition_a
+    attr_accessor :partition_a
+
+    # @type [String] partition_b
+    attr_accessor :partition_b
+
+    # @type [Number] size
+    attr_accessor :size
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @partition_a = ''
+      @partition_b = ''
+      @size = 0
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'PartitionA'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_a = v
+        when 'PartitionB'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_b = v
+        when 'Size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['PartitionA'] = @partition_a
+      ret['PartitionB'] = @partition_b
+      ret['Size'] = @size
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/policy_options.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # PolicyOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class PolicyOptions
+
+    # @type [Array<String>] delete_sources
+    attr_accessor :delete_sources
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @delete_sources = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'DeleteSources'
+          if v.nil?
+            @delete_sources = []
+          else
+            @delete_sources = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @delete_sources[i1] = v1
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['DeleteSources'] = @delete_sources
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/proxmox_connection.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # ProxmoxConnection is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProxmoxConnection
+
+    # @type [Comet::SSHConnection] ssh
+    attr_accessor :ssh
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @ssh = Comet::SSHConnection.new
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'SSH'
+          @ssh = Comet::SSHConnection.new
+          @ssh.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SSH'] = @ssh
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/proxmox_restore_target_options.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # ProxmoxRestoreTargetOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProxmoxRestoreTargetOptions
+
+    # The name of the node to restore to in the Proxmox Cluster
+    # @type [String] node
+    attr_accessor :node
+
+    # @type [Comet::SSHConnection] ssh
+    attr_accessor :ssh
+
+    # the name of the storage location to restore to
+    # @type [String] storage
+    attr_accessor :storage
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @node = ''
+      @ssh = Comet::SSHConnection.new
+      @storage = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Node'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @node = v
+        when 'SSH'
+          @ssh = Comet::SSHConnection.new
+          @ssh.from_hash(v)
+        when 'Storage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @storage = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Node'] = @node
+      ret['SSH'] = @ssh
+      ret['Storage'] = @storage
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/pvebackup_disk.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # PVEBackupDisk is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEBackupDisk
+
+    # @type [String] device
+    attr_accessor :device
+
+    # @type [Number] device_num
+    attr_accessor :device_num
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @device = ''
+      @device_num = 0
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Device'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device = v
+        when 'DeviceNum'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @device_num = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @device.nil?
+        ret['Device'] = @device
+      end
+      unless @device_num.nil?
+        ret['DeviceNum'] = @device_num
+      end
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/pvebackup_node.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # PVEBackupNode is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEBackupNode
+
+    # @type [Array<Comet::PVEBackupVM>] included_vms
+    attr_accessor :included_vms
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Boolean] selected
+    attr_accessor :selected
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @included_vms = []
+      @name = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'IncludedVMs'
+          if v.nil?
+            @included_vms = []
+          else
+            @included_vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @included_vms[i1] = Comet::PVEBackupVM.new
+              @included_vms[i1].from_hash(v1)
+            end
+          end
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Selected'
+          @selected = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @included_vms.nil?
+        ret['IncludedVMs'] = @included_vms
+      end
+      unless @name.nil?
+        ret['Name'] = @name
+      end
+      unless @selected.nil?
+        ret['Selected'] = @selected
+      end
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/pvebackup_vm.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # PVEBackupVM is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEBackupVM
+
+    # @type [Array<Comet::PVEBackupDisk>] included_disks
+    attr_accessor :included_disks
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Boolean] selected
+    attr_accessor :selected
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] vmid
+    attr_accessor :vmid
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @included_disks = []
+      @name = ''
+      @type = ''
+      @vmid = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'IncludedDisks'
+          if v.nil?
+            @included_disks = []
+          else
+            @included_disks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @included_disks[i1] = Comet::PVEBackupDisk.new
+              @included_disks[i1].from_hash(v1)
+            end
+          end
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Selected'
+          @selected = v
+        when 'Type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'VMID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @vmid = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @included_disks.nil?
+        ret['IncludedDisks'] = @included_disks
+      end
+      unless @name.nil?
+        ret['Name'] = @name
+      end
+      unless @selected.nil?
+        ret['Selected'] = @selected
+      end
+      unless @type.nil?
+        ret['Type'] = @type
+      end
+      unless @vmid.nil?
+        ret['VMID'] = @vmid
+      end
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end