comet_backup_ruby_sdk 2.41.0 → 2.42.0

data/lib/comet/models/pvedisk.rb

@@ -0,0 +1,137 @@
+# 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
+
+  # PVEDisk is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEDisk
+
+    # @type [String] device
+    attr_accessor :device
+
+    # @type [Number] device_num
+    attr_accessor :device_num
+
+    # @type [String] storage_id
+    attr_accessor :storage_id
+
+    # @type [String] volume
+    attr_accessor :volume
+
+    # @type [String] size
+    attr_accessor :size
+
+    # @type [String] format
+    attr_accessor :format
+
+    # @type [String] options
+    attr_accessor :options
+
+    # @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
+      @storage_id = ''
+      @volume = ''
+      @size = ''
+      @format = ''
+      @options = ''
+      @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
+        when 'StorageID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @storage_id = v
+        when 'Volume'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @volume = v
+        when 'Size'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @size = v
+        when 'Format'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @format = v
+        when 'Options'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @options = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Device'] = @device
+      ret['DeviceNum'] = @device_num
+      unless @storage_id.nil?
+        ret['StorageID'] = @storage_id
+      end
+      unless @volume.nil?
+        ret['Volume'] = @volume
+      end
+      unless @size.nil?
+        ret['Size'] = @size
+      end
+      unless @format.nil?
+        ret['Format'] = @format
+      end
+      unless @options.nil?
+        ret['Options'] = @options
+      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/pveparams.rb

@@ -0,0 +1,138 @@
+# 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
+
+  # PVEParams is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEParams
+
+    # @type [Boolean] everything
+    attr_accessor :everything
+
+    # @type [Array<Comet::PVEBackupNode>] exclusions
+    attr_accessor :exclusions
+
+    # @type [String] method
+    attr_accessor :method
+
+    # @type [Number] quota
+    attr_accessor :quota
+
+    # @type [Comet::SSHConnection] sshconnection
+    attr_accessor :sshconnection
+
+    # @type [Array<Comet::PVEBackupNode>] selections
+    attr_accessor :selections
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @exclusions = []
+      @method = ''
+      @quota = 0
+      @sshconnection = Comet::SSHConnection.new
+      @selections = []
+      @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 'Everything'
+          @everything = v
+        when 'Exclusions'
+          if v.nil?
+            @exclusions = []
+          else
+            @exclusions = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @exclusions[i1] = Comet::PVEBackupNode.new
+              @exclusions[i1].from_hash(v1)
+            end
+          end
+        when 'Method'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @method = v
+        when 'Quota'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @quota = v
+        when 'SSHConnection'
+          @sshconnection = Comet::SSHConnection.new
+          @sshconnection.from_hash(v)
+        when 'Selections'
+          if v.nil?
+            @selections = []
+          else
+            @selections = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @selections[i1] = Comet::PVEBackupNode.new
+              @selections[i1].from_hash(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 = {}
+      unless @everything.nil?
+        ret['Everything'] = @everything
+      end
+      unless @exclusions.nil?
+        ret['Exclusions'] = @exclusions
+      end
+      unless @method.nil?
+        ret['Method'] = @method
+      end
+      unless @quota.nil?
+        ret['Quota'] = @quota
+      end
+      unless @sshconnection.nil?
+        ret['SSHConnection'] = @sshconnection
+      end
+      unless @selections.nil?
+        ret['Selections'] = @selections
+      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/pverestore_selection.rb

@@ -0,0 +1,94 @@
+# 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
+
+  # PVERestoreSelection is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVERestoreSelection
+
+    # @type [String] id
+    attr_accessor :id
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Comet::PVEVM] target_vm
+    attr_accessor :target_vm
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @id = ''
+      @name = ''
+      @target_vm = Comet::PVEVM.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 'ID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @id = v
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'TargetVM'
+          @target_vm = Comet::PVEVM.new
+          @target_vm.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 = {}
+      unless @id.nil?
+        ret['ID'] = @id
+      end
+      unless @name.nil?
+        ret['Name'] = @name
+      end
+      ret['TargetVM'] = @target_vm
+      @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/pvestorage_name.rb

@@ -0,0 +1,83 @@
+# 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
+
+  # PVEStorageName is a typed class wrapper around the underlying Comet Server API data structure.
+  # PVEStorageName contains the name and type of storage configured on a Proxmox Cluster
+  class PVEStorageName
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @name = ''
+      @type = ''
+      @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 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Name'] = @name
+      ret['Type'] = @type
+      @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/pvevm.rb

@@ -0,0 +1,148 @@
+# 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
+
+  # PVEVM is a typed class wrapper around the underlying Comet Server API data structure.
+  class PVEVM
+
+    # @type [String] cpu
+    attr_accessor :cpu
+
+    # @type [Array<Comet::PVEDisk>] disks
+    attr_accessor :disks
+
+    # @type [String] memory
+    attr_accessor :memory
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [String] node
+    attr_accessor :node
+
+    # @type [String] ostype
+    attr_accessor :ostype
+
+    # @type [Boolean] running
+    attr_accessor :running
+
+    # @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
+      @cpu = ''
+      @disks = []
+      @memory = ''
+      @name = ''
+      @node = ''
+      @ostype = ''
+      @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 'CPU'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @cpu = v
+        when 'Disks'
+          if v.nil?
+            @disks = []
+          else
+            @disks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @disks[i1] = Comet::PVEDisk.new
+              @disks[i1].from_hash(v1)
+            end
+          end
+        when 'Memory'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @memory = v
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Node'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @node = v
+        when 'OSType'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ostype = v
+        when 'Running'
+          @running = 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 = {}
+      ret['CPU'] = @cpu
+      ret['Disks'] = @disks
+      ret['Memory'] = @memory
+      ret['Name'] = @name
+      ret['Node'] = @node
+      ret['OSType'] = @ostype
+      ret['Running'] = @running
+      ret['Type'] = @type
+      ret['VMID'] = @vmid
+      @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/registration_lobby_connection.rb

@@ -36,6 +36,9 @@ module Comet
     # @type [String] ipaddress
     attr_accessor :ipaddress
 
+    # @type [String] host
+    attr_accessor :host
+
     # @type [Number] connection_time
     attr_accessor :connection_time
 
@@ -55,6 +58,7 @@ module Comet
       @reported_platform_version = Comet::OSInfo.new
       @device_time_zone = ''
       @ipaddress = ''
+      @host = ''
       @connection_time = 0
       @unknown_json_fields = {}
     end
@@ -103,6 +107,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @ipaddress = v
+        when 'Host'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @host = v
         when 'ConnectionTime'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -130,6 +138,9 @@ module Comet
       unless @ipaddress.nil?
         ret['IPAddress'] = @ipaddress
       end
+      unless @host.nil?
+        ret['Host'] = @host
+      end
       ret['ConnectionTime'] = @connection_time
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/remote_server_address.rb

@@ -18,15 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] remote_address
     attr_accessor :remote_address
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] username
     attr_accessor :username
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/remote_storage_option.rb

@@ -18,15 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] remote_address
     attr_accessor :remote_address
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] username
     attr_accessor :username
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/replica_server.rb

@@ -18,15 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] remote_address
     attr_accessor :remote_address
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] username
     attr_accessor :username
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] password
     attr_accessor :password