comet_backup_ruby_sdk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e7a6800c1e43d0b3f33497694693dd69a090317a03ecee5a4ab8dcdbf3a8a5
-  data.tar.gz: ecbcdf90a4cf337d0f02c52c927481607611cc8f1c0c0859f2ff300e27e36a0a
+  metadata.gz: e1541c88beaa1b7b97887d18d1ba96cf31c271f509d3f379affe65e6c6d3ab48
+  data.tar.gz: cab918f37bf9e129add1555a8f39a88e32495335c70a72aee8e0f1c660573722
 SHA512:
-  metadata.gz: 1d27e14ede1f37a25afb39292f5151b85822111c9222c45718e2e3fe25a6e0496d3dd0d327eff7887eebd50c3cc817bc6e68be1034963eb451081dc32cb9fad3
-  data.tar.gz: e76b0af2406eb542afc776130c1ae1d56e4ec6d94bca5ea4118eca1b1563a0f4b925c38ddacc686014bd19d69462da4c80a608d47c97e6de269b62b639ec019c
+  metadata.gz: ae6df3cc659a753e6f3638e17988af6e0e8b5bf4ea2b88be4150b05a421b9bdfaebbcd3d6cbe4e9284f1bd2d14d5e56bd4b9c8dff83fdf66a435f1c84c7773ab
+  data.tar.gz: cdbf3a20dc309b0285f3b08b5668e6e556becbd064fa2c8b0815c5df158490db582ce4018bf3e09e7270a5da290dd70af90d49d4934bd0711065a3a4015c3371

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 2022-07-27 v2.1.0
+- Based on 22.6.7
+- Add support enforcing the `RandomDelaySecs` for both whole-server and in policies
+- Add support for username filter parameter in `AdminDispatcherListActive`
+- Add custom region parameters for S3-compatible storage
+- Add IDrive e2 as a Storage Template provider and in Constellation, including access-key cleanup
+- Add `OverwriteIfNewer` to `RestoreJobAdvancedOptions`
+- Add Office365 User Principal names
+
 ## 2022-06-28 v2.0.0
 - Based on 22.6.2
 - **BREAKING:** The `Organization.Email` class member is now declared as `EmailOptions` type instead of `AdminEmailOptions`. This change is fully backward-compatible on the HTTP/JSON level, but may cause issues if your application code checked this type explicitly

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.0.0)
+    comet_backup_ruby_sdk (2.1.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.0.0'
+  spec.version       = '2.1.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -1212,9 +1212,17 @@ module Comet
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
     #
+    # @param [String] user_name_filter (Optional) User name filter string
     # @return [Hash{String => Comet::LiveUserConnection}]
-    def admin_dispatcher_list_active
-      body = perform_request('api/v1/admin/dispatcher/list-active')
+    def admin_dispatcher_list_active(user_name_filter = nil)
+      submit_params = {}
+      unless user_name_filter.nil?
+        raise TypeError, "'user_name_filter' expected String, got #{user_name_filter.class}" unless user_name_filter.is_a? String
+
+        submit_params['UserNameFilter'] = user_name_filter
+      end
+
+      body = perform_request('api/v1/admin/dispatcher/list-active', submit_params)
       json_body = JSON.parse body
       check_status json_body
       ret = {}

data/lib/comet/definitions.rb

@@ -469,13 +469,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '22.6.3'
+  APPLICATION_VERSION = '22.6.7'
 
   APPLICATION_VERSION_MAJOR = 22
 
   APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 3
+  APPLICATION_VERSION_REVISION = 7
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -662,6 +662,9 @@ module Comet
   # RemoteServerType:
   REMOTESERVER_AWS = 'aws'
 
+  # RemoteServerType:
+  REMOTESERVER_IDRIVEE2 = 'idrivee2'
+
   # LDAPSecurityMethod:
   LDAPSECURITYMETHOD_PLAIN = 'plain'
 

data/lib/comet/models/authentication_role_options.rb

@@ -36,6 +36,9 @@ module Comet
     # @type [Array<Comet::ReplicaServer>] replicate_to
     attr_accessor :replicate_to
 
+    # @type [Comet::GlobalOverrideOptions] global_overrides
+    attr_accessor :global_overrides
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -49,6 +52,7 @@ module Comet
       @prune_logs_after_days = 0
       @remote_storage = []
       @replicate_to = []
+      @global_overrides = Comet::GlobalOverrideOptions.new
       @unknown_json_fields = {}
     end
 
@@ -103,6 +107,9 @@ module Comet
               @replicate_to[i1].from_hash(v1)
             end
           end
+        when 'GlobalOverrides'
+          @global_overrides = Comet::GlobalOverrideOptions.new
+          @global_overrides.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -120,6 +127,9 @@ module Comet
       ret['PruneLogsAfterDays'] = @prune_logs_after_days
       ret['RemoteStorage'] = @remote_storage
       ret['ReplicateTo'] = @replicate_to
+      unless @global_overrides.nil?
+        ret['GlobalOverrides'] = @global_overrides
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/bucket_usage_info.rb

@@ -12,6 +12,9 @@ module Comet
   # BucketUsageInfo is a typed class wrapper around the underlying Comet Server API data structure.
   class BucketUsageInfo
 
+    # @type [String] access_key
+    attr_accessor :access_key
+
     # @type [Array<Number>] exists_on_servers
     attr_accessor :exists_on_servers
 
@@ -26,6 +29,7 @@ module Comet
     end
 
     def clear
+      @access_key = ''
       @exists_on_servers = []
       @in_use_by = []
       @unknown_json_fields = {}
@@ -44,6 +48,10 @@ module Comet
 
       obj.each do |k, v|
         case k
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
         when 'ExistsOnServers'
           if v.nil?
             @exists_on_servers = []
@@ -74,6 +82,7 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
+      ret['AccessKey'] = @access_key
       ret['ExistsOnServers'] = @exists_on_servers
       ret['InUseBy'] = @in_use_by
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/destination_config.rb

@@ -60,6 +60,9 @@ module Comet
     # @type [String] s3subdir
     attr_accessor :s3subdir
 
+    # @type [String] s3custom_region
+    attr_accessor :s3custom_region
+
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
@@ -200,6 +203,7 @@ module Comet
       @s3secret_key = ''
       @s3bucket_name = ''
       @s3subdir = ''
+      @s3custom_region = ''
       @sftpserver = ''
       @sftpusername = ''
       @sftpremote_path = ''
@@ -331,6 +335,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @s3subdir = v
+        when 'S3CustomRegion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3custom_region = v
         when 'S3UsesV2Signing'
           @s3uses_v2signing = v
         when 'SFTPServer'
@@ -500,6 +508,7 @@ module Comet
       ret['S3SecretKey'] = @s3secret_key
       ret['S3BucketName'] = @s3bucket_name
       ret['S3Subdir'] = @s3subdir
+      ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername

data/lib/comet/models/destination_location.rb

@@ -42,6 +42,9 @@ module Comet
     # @type [String] s3subdir
     attr_accessor :s3subdir
 
+    # @type [String] s3custom_region
+    attr_accessor :s3custom_region
+
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
@@ -152,6 +155,7 @@ module Comet
       @s3secret_key = ''
       @s3bucket_name = ''
       @s3subdir = ''
+      @s3custom_region = ''
       @sftpserver = ''
       @sftpusername = ''
       @sftpremote_path = ''
@@ -232,6 +236,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @s3subdir = v
+        when 'S3CustomRegion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3custom_region = v
         when 'S3UsesV2Signing'
           @s3uses_v2signing = v
         when 'SFTPServer'
@@ -369,6 +377,7 @@ module Comet
       ret['S3SecretKey'] = @s3secret_key
       ret['S3BucketName'] = @s3bucket_name
       ret['S3Subdir'] = @s3subdir
+      ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername

data/lib/comet/models/global_override_options.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # GlobalOverrideOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class GlobalOverrideOptions
+
+    # @type [Number] random_delay_secs
+    attr_accessor :random_delay_secs
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @random_delay_secs = 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 'RandomDelaySecs'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @random_delay_secs = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @random_delay_secs.nil?
+        ret['RandomDelaySecs'] = @random_delay_secs
+      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/office_365mixed_virtual_account.rb

@@ -36,6 +36,9 @@ module Comet
     # @type [String] web_url
     attr_accessor :web_url
 
+    # @type [String] user_principal_name
+    attr_accessor :user_principal_name
+
     # @type [Number] enabled_service_option
     attr_accessor :enabled_service_option
 
@@ -67,6 +70,7 @@ module Comet
       @site_id = ''
       @web_id = ''
       @web_url = ''
+      @user_principal_name = ''
       @enabled_service_option = 0
       @members = []
       @service_options = 0
@@ -119,6 +123,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @web_url = v
+        when 'UserPrincipalName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @user_principal_name = v
         when 'EnabledServiceOption'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -175,6 +183,9 @@ module Comet
       unless @web_url.nil?
         ret['WebURL'] = @web_url
       end
+      unless @user_principal_name.nil?
+        ret['UserPrincipalName'] = @user_principal_name
+      end
       unless @enabled_service_option.nil?
         ret['EnabledServiceOption'] = @enabled_service_option
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -18,6 +18,9 @@ module Comet
     # @type [Boolean] overwrite_existing_files
     attr_accessor :overwrite_existing_files
 
+    # @type [Boolean] overwrite_if_newer
+    attr_accessor :overwrite_if_newer
+
     # @type [Boolean] dest_is_original_location
     attr_accessor :dest_is_original_location
 
@@ -68,6 +71,8 @@ module Comet
           @type = v
         when 'OverwriteExistingFiles'
           @overwrite_existing_files = v
+        when 'OverwriteIfNewer'
+          @overwrite_if_newer = v
         when 'DestIsOriginalLocation'
           @dest_is_original_location = v
         when 'DestPath'
@@ -103,6 +108,7 @@ module Comet
       ret = {}
       ret['Type'] = @type
       ret['OverwriteExistingFiles'] = @overwrite_existing_files
+      ret['OverwriteIfNewer'] = @overwrite_if_newer
       ret['DestIsOriginalLocation'] = @dest_is_original_location
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths

data/lib/comet/models/s3destination_location.rb

@@ -30,6 +30,9 @@ module Comet
     # @type [String] s3subdir
     attr_accessor :s3subdir
 
+    # @type [String] s3custom_region
+    attr_accessor :s3custom_region
+
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
@@ -46,6 +49,7 @@ module Comet
       @s3secret_key = ''
       @s3bucket_name = ''
       @s3subdir = ''
+      @s3custom_region = ''
       @unknown_json_fields = {}
     end
 
@@ -84,6 +88,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @s3subdir = v
+        when 'S3CustomRegion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3custom_region = v
         when 'S3UsesV2Signing'
           @s3uses_v2signing = v
         else
@@ -101,6 +109,7 @@ module Comet
       ret['S3SecretKey'] = @s3secret_key
       ret['S3BucketName'] = @s3bucket_name
       ret['S3Subdir'] = @s3subdir
+      ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/user_policy.rb

@@ -111,6 +111,9 @@ module Comet
     # @type [Hash{String => Comet::BackupRuleConfig}] default_backup_rules
     attr_accessor :default_backup_rules
 
+    # @type [Number] random_delay_secs
+    attr_accessor :random_delay_secs
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -132,6 +135,7 @@ module Comet
       @default_sources_backup_rules = {}
       @default_sources_with_osrestriction = {}
       @default_backup_rules = {}
+      @random_delay_secs = 0
       @unknown_json_fields = {}
     end
 
@@ -266,6 +270,10 @@ module Comet
               @default_backup_rules[k1].from_hash(v1)
             end
           end
+        when 'RandomDelaySecs'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @random_delay_secs = v
         else
           @unknown_json_fields[k] = v
         end
@@ -318,6 +326,9 @@ module Comet
       ret['DefaultSourcesBackupRules'] = @default_sources_backup_rules
       ret['DefaultSourcesWithOSRestriction'] = @default_sources_with_osrestriction
       ret['DefaultBackupRules'] = @default_backup_rules
+      unless @random_delay_secs.nil?
+        ret['RandomDelaySecs'] = @random_delay_secs
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/user_profile_config.rb

@@ -105,6 +105,9 @@ module Comet
     # @type [String] creation_guid
     attr_accessor :creation_guid
 
+    # @type [Comet::UserServerConfig] server_config
+    attr_accessor :server_config
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -135,6 +138,7 @@ module Comet
       @totpkey = ''
       @create_time = 0
       @creation_guid = ''
+      @server_config = Comet::UserServerConfig.new
       @unknown_json_fields = {}
     end
 
@@ -287,6 +291,9 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @creation_guid = v
+        when 'ServerConfig'
+          @server_config = Comet::UserServerConfig.new
+          @server_config.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -328,6 +335,9 @@ module Comet
       ret['RequirePasswordChange'] = @require_password_change
       ret['CreateTime'] = @create_time
       ret['CreationGUID'] = @creation_guid
+      unless @server_config.nil?
+        ret['ServerConfig'] = @server_config
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/user_server_config.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # UserServerConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class UserServerConfig
+
+    # @type [Number] random_delay_secs
+    attr_accessor :random_delay_secs
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @random_delay_secs = 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 'RandomDelaySecs'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @random_delay_secs = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @random_delay_secs.nil?
+        ret['RandomDelaySecs'] = @random_delay_secs
+      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_backup_ruby_sdk.rb

@@ -75,6 +75,7 @@ require_relative 'comet/models/ftpdestination_location'
 require_relative 'comet/models/get_group_policy_response'
 require_relative 'comet/models/get_profile_and_hash_response_message'
 require_relative 'comet/models/get_profile_hash_response_message'
+require_relative 'comet/models/global_override_options'
 require_relative 'comet/models/group_policy'
 require_relative 'comet/models/hour_sched_config'
 require_relative 'comet/models/httpconnector_options'
@@ -168,6 +169,7 @@ require_relative 'comet/models/user_on_server'
 require_relative 'comet/models/user_policy'
 require_relative 'comet/models/user_profile_config'
 require_relative 'comet/models/user_profile_fragment'
+require_relative 'comet/models/user_server_config'
 require_relative 'comet/models/vault_snapshot'
 require_relative 'comet/models/vmdksnapshot_view_options'
 require_relative 'comet/models/vsscomponent'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,6 +153,7 @@ files:
 - lib/comet/models/get_group_policy_response.rb
 - lib/comet/models/get_profile_and_hash_response_message.rb
 - lib/comet/models/get_profile_hash_response_message.rb
+- lib/comet/models/global_override_options.rb
 - lib/comet/models/group_policy.rb
 - lib/comet/models/hour_sched_config.rb
 - lib/comet/models/httpconnector_options.rb
@@ -246,6 +247,7 @@ files:
 - lib/comet/models/user_policy.rb
 - lib/comet/models/user_profile_config.rb
 - lib/comet/models/user_profile_fragment.rb
+- lib/comet/models/user_server_config.rb
 - lib/comet/models/vault_snapshot.rb
 - lib/comet/models/vmdksnapshot_view_options.rb
 - lib/comet/models/vsscomponent.rb