comet_backup_ruby_sdk 2.33.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9b5276738aaf54da0faa462ce15d892e9adc73f30c85498190a6b87bcc334a
-  data.tar.gz: 2740b843b7deb8d9b5f1a4976458bc7df296806de0656994d818535f492c1e1b
+  metadata.gz: 5515ec0d67e0e3f5933187f1b9abd01390de257f15acebbac6b02f1f6b323eda
+  data.tar.gz: f73f2bbcbcdacbf88dbc5f22d09eec1e15305dd88cdafeedbed3cba80394da1b
 SHA512:
-  metadata.gz: 298427323e3dd885832c689086054a7080080cd5fea6cbd2724432513b8c2df722fb99829d4a04b6789fc44263ac78720a76abc323b3ecad0323abb053bfd06b
-  data.tar.gz: aa79fd2f522e0e8e772a33f513440f0471515476b6cd29fe8b29b5345ccab08d179b8d97f1b84a846abdec18e82c32b3e3c0fa8d6f4ebe1b9db4f56cf1326bb3
+  metadata.gz: 64170e8dc7026e1ab4f50e3fa2f435d222e2502223d690ae57357b647b3c91c0ab7f3d7324c4de198423930e8d7379709fd9ceb905663374633e48ca4b54a242
+  data.tar.gz: dddc00508aae6f6543337f6157b586a6086173e5fe690823462625256b332e73fc084eb74a93002ecebb927df9b526efbad91701978cc5b5eb6a28b495e7d625

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 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
+- Added Server Device and Booster Limits
+- Added API to count devices registered on a Server
+- Added Software Build Role configuration per tenant
+
 ## 2024-06-11 v2.33.0
 
 - Based on Comet 24.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.33.0)
+    comet_backup_ruby_sdk (2.35.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.33.0'
+  spec.version       = '2.35.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.0'
+  APPLICATION_VERSION = '24.6.6'
 
   APPLICATION_VERSION_MAJOR = 24
 
   APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 6
 
   # 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/admin_user_permissions.rb

@@ -75,6 +75,10 @@ module Comet
     # @type [Array<String>] allowed_user_policies
     attr_accessor :allowed_user_policies
 
+    # This field is available in Comet 24.6.1 and later.
+    # @type [Boolean] deny_software_build_role
+    attr_accessor :deny_software_build_role
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -155,6 +159,8 @@ module Comet
               @allowed_user_policies[i1] = v1
             end
           end
+        when 'DenySoftwareBuildRole'
+          @deny_software_build_role = v
         else
           @unknown_json_fields[k] = v
         end
@@ -218,6 +224,9 @@ module Comet
       unless @allowed_user_policies.nil?
         ret['AllowedUserPolicies'] = @allowed_user_policies
       end
+      unless @deny_software_build_role.nil?
+        ret['DenySoftwareBuildRole'] = @deny_software_build_role
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

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/license_limits.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2024 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # LicenseLimits is a typed class wrapper around the underlying Comet Server API data structure.
+  class LicenseLimits
+
+    # @type [Number] device_count
+    attr_accessor :device_count
+
+    # @type [Hash{String => Number}] booster_count
+    attr_accessor :booster_count
+
+    # @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_count = 0
+      @booster_count = {}
+      @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 'deviceCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @device_count = v
+        when 'boosterCount'
+          @booster_count = {}
+          if v.nil?
+            @booster_count = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @booster_count[k1] = 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 @device_count.nil?
+        ret['deviceCount'] = @device_count
+      end
+      unless @booster_count.nil?
+        ret['boosterCount'] = @booster_count
+      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/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/server_meta_version_info.rb

@@ -62,6 +62,21 @@ module Comet
     # @type [Number] server_license_feature_set
     attr_accessor :server_license_feature_set
 
+    # If non-zero, the maximum numbers of devices and Protected Item types that this server is allowed.
+    # This field is available in Comet 24.6.3 and later.
+    # @type [Comet::LicenseLimits] server_license_limit
+    attr_accessor :server_license_limit
+
+    # A count of the devices registered on the server that have a configured Protected Item.
+    # This field is available in Comet 24.6.3 and later.
+    # @type [Number] configured_devices
+    attr_accessor :configured_devices
+
+    # The current number of Protected Item types configured on the server.
+    # This field is available in Comet 24.6.3 and later.
+    # @type [Hash{String => Number}] booster_limit
+    attr_accessor :booster_limit
+
     # Unix timestamp, in seconds.
     # @type [Number] license_valid_until
     attr_accessor :license_valid_until
@@ -110,6 +125,9 @@ module Comet
       @current_time = 0
       @server_license_hash = ''
       @server_license_feature_set = 0
+      @server_license_limit = Comet::LicenseLimits.new
+      @configured_devices = 0
+      @booster_limit = {}
       @license_valid_until = 0
       @emails_sent_successfully = 0
       @emails_sent_errors = 0
@@ -186,6 +204,24 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @server_license_feature_set = v
+        when 'ServerLicenseLimit'
+          @server_license_limit = Comet::LicenseLimits.new
+          @server_license_limit.from_hash(v)
+        when 'ConfiguredDevices'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @configured_devices = v
+        when 'BoosterLimit'
+          @booster_limit = {}
+          if v.nil?
+            @booster_limit = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @booster_limit[k1] = v1
+            end
+          end
         when 'LicenseValidUntil'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -255,6 +291,9 @@ module Comet
       ret['ServerLicenseHash'] = @server_license_hash
       ret['ServerLicenseFeaturesAll'] = @server_license_features_all
       ret['ServerLicenseFeatureSet'] = @server_license_feature_set
+      ret['ServerLicenseLimit'] = @server_license_limit
+      ret['ConfiguredDevices'] = @configured_devices
+      ret['BoosterLimit'] = @booster_limit
       ret['LicenseValidUntil'] = @license_valid_until
       ret['EmailsSentSuccessfully'] = @emails_sent_successfully
       ret['EmailsSentErrors'] = @emails_sent_errors

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_backup_ruby_sdk.rb

@@ -93,6 +93,7 @@ require_relative 'comet/models/install_creds'
 require_relative 'comet/models/install_token'
 require_relative 'comet/models/install_token_response'
 require_relative 'comet/models/job_entry'
+require_relative 'comet/models/license_limits'
 require_relative 'comet/models/license_options'
 require_relative 'comet/models/live_user_connection'
 require_relative 'comet/models/local_destination_location'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.33.0
+  version: 2.35.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ files:
 - lib/comet/models/install_token.rb
 - lib/comet/models/install_token_response.rb
 - lib/comet/models/job_entry.rb
+- lib/comet/models/license_limits.rb
 - lib/comet/models/license_options.rb
 - lib/comet/models/live_user_connection.rb
 - lib/comet/models/local_destination_location.rb