comet_backup_ruby_sdk 2.40.0 → 2.42.0

data/lib/comet/models/request_storage_vault_response_message.rb

@@ -22,6 +22,12 @@ module Comet
     # @type [String] destination_id
     attr_accessor :destination_id
 
+    # @type [String] profile_hash
+    attr_accessor :profile_hash
+
+    # @type [Comet::UserProfileConfig] profile
+    attr_accessor :profile
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -33,6 +39,8 @@ module Comet
       @status = 0
       @message = ''
       @destination_id = ''
+      @profile_hash = ''
+      @profile = Comet::UserProfileConfig.new
       @unknown_json_fields = {}
     end
 
@@ -61,6 +69,13 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @destination_id = v
+        when 'ProfileHash'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @profile_hash = v
+        when 'Profile'
+          @profile = Comet::UserProfileConfig.new
+          @profile.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -73,6 +88,8 @@ module Comet
       ret['Status'] = @status
       ret['Message'] = @message
       ret['DestinationID'] = @destination_id
+      ret['ProfileHash'] = @profile_hash
+      ret['Profile'] = @profile
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -107,6 +107,20 @@ module Comet
     # @type [Comet::MSSQLLoginArgs] ms_sql_connection
     attr_accessor :ms_sql_connection
 
+    # For RESTORETYPE_VMHOST
+    # This field is available in Comet 24.12.x and later.
+    # @type [Comet::VMwareRestoreTargetOptions] vmware_connection
+    attr_accessor :vmware_connection
+
+    # For RESTORETYPE_VMHOST
+    # This field is available in Comet 24.12.x and later.
+    # @type [Comet::HyperVRestoreTargetOptions] hyper_vconnection
+    attr_accessor :hyper_vconnection
+
+    # For RESTORETYPE_VMHOST
+    # @type [Comet::ProxmoxRestoreTargetOptions] proxmox_connection
+    attr_accessor :proxmox_connection
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -128,6 +142,9 @@ module Comet
       @ssl_crt_file = ''
       @ssl_key_file = ''
       @ms_sql_connection = Comet::MSSQLLoginArgs.new
+      @vmware_connection = Comet::VMwareRestoreTargetOptions.new
+      @hyper_vconnection = Comet::HyperVRestoreTargetOptions.new
+      @proxmox_connection = Comet::ProxmoxRestoreTargetOptions.new
       @unknown_json_fields = {}
     end
 
@@ -219,6 +236,15 @@ module Comet
         when 'MsSqlConnection'
           @ms_sql_connection = Comet::MSSQLLoginArgs.new
           @ms_sql_connection.from_hash(v)
+        when 'VMwareConnection'
+          @vmware_connection = Comet::VMwareRestoreTargetOptions.new
+          @vmware_connection.from_hash(v)
+        when 'HyperVConnection'
+          @hyper_vconnection = Comet::HyperVRestoreTargetOptions.new
+          @hyper_vconnection.from_hash(v)
+        when 'ProxmoxConnection'
+          @proxmox_connection = Comet::ProxmoxRestoreTargetOptions.new
+          @proxmox_connection.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -254,6 +280,15 @@ module Comet
       unless @ms_sql_connection.nil?
         ret['MsSqlConnection'] = @ms_sql_connection
       end
+      unless @vmware_connection.nil?
+        ret['VMwareConnection'] = @vmware_connection
+      end
+      unless @hyper_vconnection.nil?
+        ret['HyperVConnection'] = @hyper_vconnection
+      end
+      unless @proxmox_connection.nil?
+        ret['ProxmoxConnection'] = @proxmox_connection
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/retention_range.rb

@@ -34,6 +34,9 @@ module Comet
     # @type [Number] months
     attr_accessor :months
 
+    # @type [Number] years
+    attr_accessor :years
+
     # 0: Sunday, 6: Saturday
     # @type [Number] week_offset
     attr_accessor :week_offset
@@ -45,6 +48,9 @@ module Comet
     # @type [Number] month_offset
     attr_accessor :month_offset
 
+    # @type [Number] year_offset
+    attr_accessor :year_offset
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -59,8 +65,10 @@ module Comet
       @days = 0
       @weeks = 0
       @months = 0
+      @years = 0
       @week_offset = 0
       @month_offset = 0
+      @year_offset = 0
       @unknown_json_fields = {}
     end
 
@@ -101,6 +109,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @months = v
+        when 'Years'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @years = v
         when 'WeekOffset'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -109,6 +121,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @month_offset = v
+        when 'YearOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @year_offset = v
         else
           @unknown_json_fields[k] = v
         end
@@ -124,8 +140,10 @@ module Comet
       ret['Days'] = @days
       ret['Weeks'] = @weeks
       ret['Months'] = @months
+      ret['Years'] = @years
       ret['WeekOffset'] = @week_offset
       ret['MonthOffset'] = @month_offset
+      ret['YearOffset'] = @year_offset
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/schedule_config.rb

@@ -39,6 +39,12 @@ module Comet
     # @type [Number] random_delay_secs
     attr_accessor :random_delay_secs
 
+    # @type [Number] selected_month
+    attr_accessor :selected_month
+
+    # @type [Number] selected_day
+    attr_accessor :selected_day
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -54,6 +60,8 @@ module Comet
       @to_time = Comet::HourSchedConfig.new
       @days_select = Comet::DaysOfWeekConfig.new
       @random_delay_secs = 0
+      @selected_month = 0
+      @selected_day = 0
       @unknown_json_fields = {}
     end
 
@@ -99,6 +107,14 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @random_delay_secs = v
+        when 'SelectedMonth'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @selected_month = v
+        when 'SelectedDay'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @selected_day = v
         else
           @unknown_json_fields[k] = v
         end
@@ -121,6 +137,8 @@ module Comet
       unless @random_delay_secs.nil?
         ret['RandomDelaySecs'] = @random_delay_secs
       end
+      ret['SelectedMonth'] = @selected_month
+      ret['SelectedDay'] = @selected_day
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/self_backup_export_options.rb

@@ -26,8 +26,8 @@ module Comet
     # @type [Number] compression
     attr_accessor :compression
 
-    # The jobs database is often the largest component of the Server Self-Backup archive. By excluding
-    # it, you could run the Server Self-Backup more often.
+    # The jobs database is often the largest component of the System Self-Backup archive. By excluding
+    # it, you could run the System Self-Backup more often.
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 

data/lib/comet/models/self_backup_target.rb

@@ -36,8 +36,8 @@ module Comet
     # @type [Number] compression
     attr_accessor :compression
 
-    # The jobs database is often the largest component of the Server Self-Backup archive. By excluding
-    # it, you could run the Server Self-Backup more often.
+    # The jobs database is often the largest component of the System Self-Backup archive. By excluding
+    # it, you could run the System Self-Backup more often.
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 

data/lib/comet/models/user_policy.rb

@@ -129,6 +129,11 @@ module Comet
     # @type [Number] random_delay_secs
     attr_accessor :random_delay_secs
 
+    # Rotate access keys of a conflicting jobs Storage Vault, if no update from the conflicting job for
+    # X hours. If value is 0, ROTATE_STORAGE_VAULT_KEYS_DEFAULT is used.
+    # @type [Number] rotate_storage_vault_keys_hours
+    attr_accessor :rotate_storage_vault_keys_hours
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -155,6 +160,7 @@ module Comet
       @default_sources_with_osrestriction = {}
       @default_backup_rules = {}
       @random_delay_secs = 0
+      @rotate_storage_vault_keys_hours = 0
       @unknown_json_fields = {}
     end
 
@@ -311,6 +317,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @random_delay_secs = v
+        when 'RotateStorageVaultKeysHours'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @rotate_storage_vault_keys_hours = v
         else
           @unknown_json_fields[k] = v
         end
@@ -377,6 +387,7 @@ module Comet
       unless @random_delay_secs.nil?
         ret['RandomDelaySecs'] = @random_delay_secs
       end
+      ret['RotateStorageVaultKeysHours'] = @rotate_storage_vault_keys_hours
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/vmdisk_info.rb

@@ -0,0 +1,105 @@
+# 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
+
+  # VMDiskInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMDiskInfo
+
+    # Relative path within this backup job snapshot to root disk files
+    # @type [String] path
+    attr_accessor :path
+
+    # The virtual size of the virtual disk
+    # @type [Number] size
+    attr_accessor :size
+
+    # Controller number where the disk is associated to
+    # @type [Number] controller
+    attr_accessor :controller
+
+    # Device number within the controller
+    # @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
+      @path = ''
+      @size = 0
+      @controller = 0
+      @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 'Path'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path = v
+        when 'Size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        when 'Controller'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @controller = 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 = {}
+      ret['Path'] = @path
+      ret['Size'] = @size
+      ret['Controller'] = @controller
+      ret['DeviceNum'] = @device_num
+      @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/vminfo.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
+
+  # VMInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMInfo
+
+    # @type [String] id
+    attr_accessor :id
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Number] cpucores
+    attr_accessor :cpucores
+
+    # Bytes
+    # @type [Number] ram_bytes
+    attr_accessor :ram_bytes
+
+    # The BIOS mode of this machine e.g. "Legacy"|"UEFI"
+    # @type [String] firmware_type
+    attr_accessor :firmware_type
+
+    # Relative path to config file or directory, if supported by this Protected Item type
+    # @type [String] config_path
+    attr_accessor :config_path
+
+    # @type [Array<Comet::VMDiskInfo>] disks
+    attr_accessor :disks
+
+    # @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 = ''
+      @cpucores = 0
+      @ram_bytes = 0
+      @firmware_type = ''
+      @config_path = ''
+      @disks = []
+      @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 'CPUCores'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @cpucores = v
+        when 'RamBytes'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @ram_bytes = v
+        when 'FirmwareType'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @firmware_type = v
+        when 'ConfigPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @config_path = v
+        when 'Disks'
+          if v.nil?
+            @disks = []
+          else
+            @disks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @disks[i1] = Comet::VMDiskInfo.new
+              @disks[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 = {}
+      ret['ID'] = @id
+      ret['Name'] = @name
+      ret['CPUCores'] = @cpucores
+      ret['RamBytes'] = @ram_bytes
+      ret['FirmwareType'] = @firmware_type
+      ret['ConfigPath'] = @config_path
+      ret['Disks'] = @disks
+      @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/vminfo_list.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
+
+  # VMInfoList is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMInfoList
+
+    # @type [Array<Comet::VMInfo>] vms
+    attr_accessor :vms
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @vms = []
+      @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 'VMs'
+          if v.nil?
+            @vms = []
+          else
+            @vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @vms[i1] = Comet::VMInfo.new
+              @vms[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 = {}
+      ret['VMs'] = @vms
+      @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/vmware_datacenter_info.rb

@@ -0,0 +1,74 @@
+# 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
+
+  # VMwareDatacenterInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # VMwareDatacenterInfo describes a single VMware datacenter.
+  class VMwareDatacenterInfo
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @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 = ''
+      @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
+        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
+      @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