comet_backup_ruby_sdk 2.34.0 → 2.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a5650246c6d613c814ac6c29ce1e20b08d354731c9a6552f350e86f7540c059
-  data.tar.gz: d05bbd26c3e6fa334ae38b799911de26e52486fac77d8fb87b99e02bbcd1f84a
+  metadata.gz: 9d9fc30a121c374d4b92dd55afb55c535b02da997d4d37efe5ff549c5c4403f4
+  data.tar.gz: ac4736937b564fcc2e689d7b3cacec002fab32a2d615037893a789b95002d8aa
 SHA512:
-  metadata.gz: de6d656ff7144991407310eff6850bdfa2df887c9f0fe93ed8f52bef4c78c786c24e72d2ac5d966e69fccded36f28b85666cb7de5f08674130a70bf495a55abf
-  data.tar.gz: baa8c18ea3bfc5e98445e3ec1e0f0828fb5c76e53f74418f0a73b2e0c9a8ca7b05dd7234c8eb768d69ab17a937237c38d95e82a59d2c765a4087b7d729e29de2
+  metadata.gz: ccb3449005c19d46da142f4678c4a468aafe36b1b44bd543bb182fa0cdcf7cfadbe4c84cd61d8643bfee80c5ead9f3ae3ab1ff0d3712d93dcc163379bd349c9e
+  data.tar.gz: 2ecbe31ae73af5eed45ea24cdfc6be68d9727a5bc99fb23cf807917165e31e3c51acae5424e97ada6b8ed3420b5afcf8fbb4f79e865956c79521c2b63715746e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 2024-09-17 v2.36.0
+
+- Based on Comet 24.9.1
+- Added Hyper-V Guest limits per user
+- Added VMware Guest limits per user
+- Added protected item type (engine) to protected item class
+- Added Force Overwrite Restore permissions
+
+## 2024-08-01 v2.35.0
+
+- Based on Comet 24.6.6
+- Add new AdminConvertStorageRole API
+- Update data types for new job retry feature (BackupJobDetail, BackupRuleEventTriggers, and new JOB_STATUS_RUNNING_TRYAGAIN)
+- Add support for custom Prefix in S3GenericVirtualStorageRole
+
 ## 2024-07-16 v2.34.0
 
 - Based on Comet 24.6.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.34.0)
+    comet_backup_ruby_sdk (2.36.0)
 
 GEM
   remote: https://rubygems.org/

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '2.34.0'
+  spec.version       = '2.36.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -949,6 +949,32 @@ module Comet
       ret
     end
 
+    # AdminConvertStorageRole
+    #
+    # Convert IAM Storage Role vault to its underlying S3 type.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] target_user The user to receive the new Storage Vault
+    # @param [String] destination_id The id of the old storage role destination to convert
+    # @return [Comet::RequestStorageVaultResponseMessage]
+    def admin_convert_storage_role(target_user, destination_id)
+      submit_params = {}
+      raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError, "'destination_id' expected String, got #{destination_id.class}" unless destination_id.is_a? String
+
+      submit_params['DestinationId'] = destination_id
+
+      body = perform_request('api/v1/admin/convert-storage-role', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::RequestStorageVaultResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminCountJobsForCustomSearch
     #
     # Count jobs (for custom search).

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '24.6.4'
+  APPLICATION_VERSION = '24.9.1'
 
   APPLICATION_VERSION_MAJOR = 24
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 4
+  APPLICATION_VERSION_REVISION = 1
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -81,6 +81,14 @@ module Comet
   # CustomRemoteBucketCustomBodyType
   CUSTOMREMOTEBUCKET_CUSTOMBODY_FORM = 'form'
 
+  # The number of retry attempts a backup job can do
+  # This const is available in Comet 24.6.6 and later.
+  DEFAULT_RETRY_COUNT = 1
+
+  # The number of minutes between backup job retry attempts
+  # This const is available in Comet 24.6.6 and later.
+  DEFAULT_RETRY_TIME = 30
+
   # LanguageCode
   DEFAULT_LANGUAGE = 'en_US'
 
@@ -311,6 +319,9 @@ module Comet
   # JobStatus: The job was thought to have been in an Abandoned state but updated the Comet Server with a running status.
   JOB_STATUS_RUNNING_REVIVED = 6002
 
+  # JobStatus: The job has encountered an error and will wait to retry.
+  JOB_STATUS_RUNNING_TRYAGAIN = 6003
+
   # JobStatus
   JOB_STATUS_RUNNING__MAX = 6999
 
@@ -362,6 +373,10 @@ module Comet
   # MacOSCodesignLevel: Sign, notarize, and staple
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
+  MIN_BUILD_NUMBER_WIN_SERVER_2016 = 14_393
+
+  MIN_BUILD_NUMBER_WIN_10 = 10_240
+
   MIXED_VIRTUAL_ACCOUNT_TYPE_USER = 1
 
   MIXED_VIRTUAL_ACCOUNT_TYPE_GROUP = 2

data/lib/comet/models/backup_job_detail.rb

@@ -32,6 +32,9 @@ module Comet
     # @type [Number] end_time
     attr_accessor :end_time
 
+    # @type [Number] retry_count
+    attr_accessor :retry_count
+
     # The Protected Item that this job is for
     # @type [String] source_guid
     attr_accessor :source_guid
@@ -46,6 +49,11 @@ module Comet
     # @type [String] snapshot_id
     attr_accessor :snapshot_id
 
+    # The ID of the backup rule that contains the schedule that triggered this job
+    # This field is available in Comet 24.6.6 and later.
+    # @type [String] backup_rule_guid
+    attr_accessor :backup_rule_guid
+
     # @type [String] client_version
     attr_accessor :client_version
 
@@ -122,10 +130,12 @@ module Comet
       @status = 0
       @start_time = 0
       @end_time = 0
+      @retry_count = 0
       @source_guid = ''
       @destination_guid = ''
       @device_id = ''
       @snapshot_id = ''
+      @backup_rule_guid = ''
       @client_version = ''
       @total_directories = 0
       @total_files = 0
@@ -183,6 +193,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @end_time = v
+        when 'RetryCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @retry_count = v
         when 'SourceGUID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -199,6 +213,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @snapshot_id = v
+        when 'BackupRuleGUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @backup_rule_guid = v
         when 'ClientVersion'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -279,12 +297,16 @@ module Comet
       ret['Status'] = @status
       ret['StartTime'] = @start_time
       ret['EndTime'] = @end_time
+      ret['RetryCount'] = @retry_count
       ret['SourceGUID'] = @source_guid
       ret['DestinationGUID'] = @destination_guid
       ret['DeviceID'] = @device_id
       unless @snapshot_id.nil?
         ret['SnapshotID'] = @snapshot_id
       end
+      unless @backup_rule_guid.nil?
+        ret['BackupRuleGUID'] = @backup_rule_guid
+      end
       ret['ClientVersion'] = @client_version
       ret['TotalDirectories'] = @total_directories
       ret['TotalFiles'] = @total_files

data/lib/comet/models/backup_rule_event_triggers.rb

@@ -21,6 +21,21 @@ module Comet
     # @type [Boolean] on_pcboot_if_last_job_missed
     attr_accessor :on_pcboot_if_last_job_missed
 
+    # The option to enable retrying when a backup job failed.
+    # This field is available in Comet 24.6.6 and later.
+    # @type [Boolean] on_last_job_fail_do_retry
+    attr_accessor :on_last_job_fail_do_retry
+
+    # The number of retries when the backup job fails.
+    # This field is available in Comet 24.6.6 and later.
+    # @type [Number] last_job_fail_do_retry_count
+    attr_accessor :last_job_fail_do_retry_count
+
+    # The number of minutes before retrying when the backup job fails.
+    # This field is available in Comet 24.6.6 and later.
+    # @type [Number] last_job_fail_do_retry_time
+    attr_accessor :last_job_fail_do_retry_time
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -29,6 +44,8 @@ module Comet
     end
 
     def clear
+      @last_job_fail_do_retry_count = 0
+      @last_job_fail_do_retry_time = 0
       @unknown_json_fields = {}
     end
 
@@ -49,6 +66,16 @@ module Comet
           @on_pcboot = v
         when 'OnPCBootIfLastJobMissed'
           @on_pcboot_if_last_job_missed = v
+        when 'OnLastJobFailDoRetry'
+          @on_last_job_fail_do_retry = v
+        when 'LastJobFailDoRetryCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_job_fail_do_retry_count = v
+        when 'LastJobFailDoRetryTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_job_fail_do_retry_time = v
         else
           @unknown_json_fields[k] = v
         end
@@ -64,6 +91,15 @@ module Comet
       unless @on_pcboot_if_last_job_missed.nil?
         ret['OnPCBootIfLastJobMissed'] = @on_pcboot_if_last_job_missed
       end
+      unless @on_last_job_fail_do_retry.nil?
+        ret['OnLastJobFailDoRetry'] = @on_last_job_fail_do_retry
+      end
+      unless @last_job_fail_do_retry_count.nil?
+        ret['LastJobFailDoRetryCount'] = @last_job_fail_do_retry_count
+      end
+      unless @last_job_fail_do_retry_time.nil?
+        ret['LastJobFailDoRetryTime'] = @last_job_fail_do_retry_time
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -28,6 +28,11 @@ module Comet
     # @type [Boolean] overwrite_if_different_content
     attr_accessor :overwrite_if_different_content
 
+    # For RESTORETYPE_FILE. If set, OverwriteExistingFiles must be true. This can be set in combination
+    # with other OverwriteIf options.
+    # @type [Boolean] overwrite_force_permissions
+    attr_accessor :overwrite_force_permissions
+
     # For RESTORETYPE_FILE. If set, DestPath must be blank
     # @type [Boolean] dest_is_original_location
     attr_accessor :dest_is_original_location
@@ -149,6 +154,8 @@ module Comet
           @overwrite_if_newer = v
         when 'OverwriteIfDifferentContent'
           @overwrite_if_different_content = v
+        when 'OverwriteForcePermissions'
+          @overwrite_force_permissions = v
         when 'DestIsOriginalLocation'
           @dest_is_original_location = v
         when 'DestPath'
@@ -225,6 +232,7 @@ module Comet
       ret['OverwriteExistingFiles'] = @overwrite_existing_files
       ret['OverwriteIfNewer'] = @overwrite_if_newer
       ret['OverwriteIfDifferentContent'] = @overwrite_if_different_content
+      ret['OverwriteForcePermissions'] = @overwrite_force_permissions
       ret['DestIsOriginalLocation'] = @dest_is_original_location
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths

data/lib/comet/models/s3generic_virtual_storage_role.rb

@@ -61,6 +61,11 @@ module Comet
     # @type [String] region
     attr_accessor :region
 
+    # Optional. Prefix to use for bucket paths.
+    # This field is available in Comet 24.6.3 and later.
+    # @type [String] prefix
+    attr_accessor :prefix
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -77,6 +82,7 @@ module Comet
       @object_lock_mode = 0
       @object_lock_days = 0
       @region = ''
+      @prefix = ''
       @unknown_json_fields = {}
     end
 
@@ -129,6 +135,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @region = v
+        when 'Prefix'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @prefix = v
         else
           @unknown_json_fields[k] = v
         end
@@ -148,6 +158,7 @@ module Comet
       ret['ObjectLockDays'] = @object_lock_days
       ret['RemoveDeleted'] = @remove_deleted
       ret['Region'] = @region
+      ret['Prefix'] = @prefix
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/source_basic_info.rb

@@ -14,12 +14,18 @@ module Comet
 # Protected Items, in order to safely perform retention passes on their behalf.
   class SourceBasicInfo
 
+    # @type [String] engine
+    attr_accessor :engine
+
     # @type [String] description
     attr_accessor :description
 
     # @type [Number] o365account_count
     attr_accessor :o365account_count
 
+    # @type [Number] total_vm_count
+    attr_accessor :total_vm_count
+
     # Bytes
     # @type [Number] size
     attr_accessor :size
@@ -35,8 +41,10 @@ module Comet
     end
 
     def clear
+      @engine = ''
       @description = ''
       @o365account_count = 0
+      @total_vm_count = 0
       @size = 0
       @override_destination_retention = {}
       @unknown_json_fields = {}
@@ -55,6 +63,10 @@ module Comet
 
       obj.each do |k, v|
         case k
+        when 'Engine'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @engine = v
         when 'Description'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -63,6 +75,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @o365account_count = v
+        when 'TotalVmCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_vm_count = v
         when 'Size'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -86,8 +102,10 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
+      ret['Engine'] = @engine
       ret['Description'] = @description
       ret['O365AccountCount'] = @o365account_count
+      ret['TotalVmCount'] = @total_vm_count
       ret['Size'] = @size
       unless @override_destination_retention.nil?
         ret['OverrideDestinationRetention'] = @override_destination_retention

data/lib/comet/models/user_policy.rb

@@ -48,6 +48,15 @@ module Comet
     # @type [Number] mode_schedule_skip_already_running
     attr_accessor :mode_schedule_skip_already_running
 
+    # @type [Number] mode_schedule_last_job_fail_do_retry
+    attr_accessor :mode_schedule_last_job_fail_do_retry
+
+    # @type [Number] mode_last_job_fail_do_retry_time
+    attr_accessor :mode_last_job_fail_do_retry_time
+
+    # @type [Number] mode_last_job_fail_do_retry_count
+    attr_accessor :mode_last_job_fail_do_retry_count
+
     # @type [Number] mode_admin_reset_password
     attr_accessor :mode_admin_reset_password
 
@@ -129,6 +138,9 @@ module Comet
       @protected_item_engine_types = Comet::ProtectedItemEngineTypePolicy.new
       @file_and_folder_mandatory_exclusions = []
       @mode_schedule_skip_already_running = 0
+      @mode_schedule_last_job_fail_do_retry = 0
+      @mode_last_job_fail_do_retry_time = 0
+      @mode_last_job_fail_do_retry_count = 0
       @mode_admin_reset_password = 0
       @mode_admin_view_filenames = 0
       @mode_require_user_reset_password = 0
@@ -191,6 +203,18 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @mode_schedule_skip_already_running = v
+        when 'ModeScheduleLastJobFailDoRetry'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @mode_schedule_last_job_fail_do_retry = v
+        when 'ModeLastJobFailDoRetryTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @mode_last_job_fail_do_retry_time = v
+        when 'ModeLastJobFailDoRetryCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @mode_last_job_fail_do_retry_count = v
         when 'ModeAdminResetPassword'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -304,6 +328,15 @@ module Comet
       unless @mode_schedule_skip_already_running.nil?
         ret['ModeScheduleSkipAlreadyRunning'] = @mode_schedule_skip_already_running
       end
+      unless @mode_schedule_last_job_fail_do_retry.nil?
+        ret['ModeScheduleLastJobFailDoRetry'] = @mode_schedule_last_job_fail_do_retry
+      end
+      unless @mode_last_job_fail_do_retry_time.nil?
+        ret['ModeLastJobFailDoRetryTime'] = @mode_last_job_fail_do_retry_time
+      end
+      unless @mode_last_job_fail_do_retry_count.nil?
+        ret['ModeLastJobFailDoRetryCount'] = @mode_last_job_fail_do_retry_count
+      end
       unless @mode_admin_reset_password.nil?
         ret['ModeAdminResetPassword'] = @mode_admin_reset_password
       end

data/lib/comet/models/user_profile_config.rb

@@ -101,6 +101,16 @@ module Comet
     # @type [Number] quota_office_365protected_accounts
     attr_accessor :quota_office_365protected_accounts
 
+    # A limit on the total number of Hyper-V guests across all Hyper-V Protected Items in this account.
+    # Set to zero to allow unlimited Office 365 Protected Accounts.
+    # @type [Number] quota_hyper_vguests
+    attr_accessor :quota_hyper_vguests
+
+    # A limit on the total number of VMware guests across all VMware Protected Items in this account.
+    # Set to zero to allow unlimited Office 365 Protected Accounts.
+    # @type [Number] quota_vmware_guests
+    attr_accessor :quota_vmware_guests
+
     # If the PolicyID field is set to a non-empty string, the Comet Server will enforce the contents of
     # the Policy field based on the matching server's policy. Otherwise if the PolicyID field is set to
     # an empty string, the administrator may configure any custom values in the Policy field.
@@ -182,6 +192,8 @@ module Comet
       @all_protected_items_quota_bytes = 0
       @maximum_devices = 0
       @quota_office_365protected_accounts = 0
+      @quota_hyper_vguests = 0
+      @quota_vmware_guests = 0
       @policy_id = ''
       @policy = Comet::UserPolicy.new
       @password_format = 0
@@ -311,6 +323,14 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @quota_office_365protected_accounts = v
+        when 'QuotaHyperVGuests'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @quota_hyper_vguests = v
+        when 'QuotaVMwareGuests'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @quota_vmware_guests = v
         when 'PolicyID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -386,6 +406,8 @@ module Comet
       ret['AllProtectedItemsQuotaBytes'] = @all_protected_items_quota_bytes
       ret['MaximumDevices'] = @maximum_devices
       ret['QuotaOffice365ProtectedAccounts'] = @quota_office_365protected_accounts
+      ret['QuotaHyperVGuests'] = @quota_hyper_vguests
+      ret['QuotaVMwareGuests'] = @quota_vmware_guests
       ret['PolicyID'] = @policy_id
       ret['Policy'] = @policy
       ret['PasswordFormat'] = @password_format

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.34.0
+  version: 2.36.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler