comet_backup_ruby_sdk 2.26.0 → 2.27.0

data/lib/comet/models/replica_server.rb

@@ -18,12 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] remote_address
     attr_accessor :remote_address
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] username
     attr_accessor :username
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] password
     attr_accessor :password
 
@@ -33,25 +36,38 @@ module Comet
     # @type [Comet::OidcConfig] oidc
     attr_accessor :oidc
 
+    # Backblaze B2 (Storage Template / Constellation)
     # @type [Comet::B2VirtualStorageRoleSettings] b2
     attr_accessor :b2
 
+    # Wasabi, or Comet Storage powered by Wasabi (Storage Template / Constellation)
     # @type [Comet::WasabiVirtualStorageRoleSettings] wasabi
     attr_accessor :wasabi
 
+    # Custom Remote Bucket HTTP protocol (Storage Template)
     # @type [Comet::CustomRemoteBucketSettings] custom
     attr_accessor :custom
 
+    # IDrive e2, or Custom IAM-compatible (Storage Template / Constellation)
     # @type [Comet::S3GenericVirtualStorageRole] s3
     attr_accessor :s3
 
-    # Amazon AWS - Virtual Storage Role
+    # Amazon AWS (Storage Template / Constellation)
     # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
     attr_accessor :aws
 
+    # Storj (Storage Template / Constellation)
     # @type [Comet::StorjVirtualStorageRoleSetting] storj
     attr_accessor :storj
 
+    # Impossible Cloud Partner API (Storage Template / Constellation)
+    # @type [Comet::ImpossibleCloudPartnerTemplateSettings] imp_partner
+    attr_accessor :imp_partner
+
+    # Impossible Cloud IAM API (Storage Template / Constellation)
+    # @type [Comet::ImpossibleCloudIAMTemplateSettings] imp_user
+    attr_accessor :imp_user
+
     # @type [String] replica_deletion_strategy
     attr_accessor :replica_deletion_strategy
 
@@ -76,6 +92,8 @@ module Comet
       @s3 = Comet::S3GenericVirtualStorageRole.new
       @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
       @storj = Comet::StorjVirtualStorageRoleSetting.new
+      @imp_partner = Comet::ImpossibleCloudPartnerTemplateSettings.new
+      @imp_user = Comet::ImpossibleCloudIAMTemplateSettings.new
       @replica_deletion_strategy = ''
       @unknown_json_fields = {}
     end
@@ -137,6 +155,12 @@ module Comet
         when 'Storj'
           @storj = Comet::StorjVirtualStorageRoleSetting.new
           @storj.from_hash(v)
+        when 'ImpPartner'
+          @imp_partner = Comet::ImpossibleCloudPartnerTemplateSettings.new
+          @imp_partner.from_hash(v)
+        when 'ImpUser'
+          @imp_user = Comet::ImpossibleCloudIAMTemplateSettings.new
+          @imp_user.from_hash(v)
         when 'ReplicaDeletionStrategy'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -185,6 +209,12 @@ module Comet
       unless @storj.nil?
         ret['Storj'] = @storj
       end
+      unless @imp_partner.nil?
+        ret['ImpPartner'] = @imp_partner
+      end
+      unless @imp_user.nil?
+        ret['ImpUser'] = @imp_user
+      end
       unless @replica_deletion_strategy.nil?
         ret['ReplicaDeletionStrategy'] = @replica_deletion_strategy
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -24,6 +24,10 @@ module Comet
     # @type [Boolean] overwrite_if_newer
     attr_accessor :overwrite_if_newer
 
+    # For RESTORETYPE_FILE. If set, OverwriteExistingFiles must be true
+    # @type [Boolean] overwrite_if_different_content
+    attr_accessor :overwrite_if_different_content
+
     # For RESTORETYPE_FILE. If set, DestPath must be blank
     # @type [Boolean] dest_is_original_location
     attr_accessor :dest_is_original_location
@@ -143,6 +147,8 @@ module Comet
           @overwrite_existing_files = v
         when 'OverwriteIfNewer'
           @overwrite_if_newer = v
+        when 'OverwriteIfDifferentContent'
+          @overwrite_if_different_content = v
         when 'DestIsOriginalLocation'
           @dest_is_original_location = v
         when 'DestPath'
@@ -218,6 +224,7 @@ module Comet
       ret['Type'] = @type
       ret['OverwriteExistingFiles'] = @overwrite_existing_files
       ret['OverwriteIfNewer'] = @overwrite_if_newer
+      ret['OverwriteIfDifferentContent'] = @overwrite_if_different_content
       ret['DestIsOriginalLocation'] = @dest_is_original_location
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths

data/lib/comet/models/s3generic_virtual_storage_role.rb

@@ -12,12 +12,21 @@ module Comet
   # S3GenericVirtualStorageRole is a typed class wrapper around the underlying Comet Server API data structure.
   class S3GenericVirtualStorageRole
 
+    # The URL for S3 API calls (e.g. "s3.amazonaws.com")
     # @type [String] s3endpoint
     attr_accessor :s3endpoint
 
+    # The URL for IAM API calls (e.g. "iam.amazonaws.com")
     # @type [String] iamendpoint
     attr_accessor :iamendpoint
 
+    # If set, the Storage Template will generate Storage Vaults pointing to a subdirectory within this
+    # bucket. A single dynamic IAM policy will cover all created Storage Vaults.
+    # This is preferable for platforms that have limits on the total number of IAM policies. However, it
+    # requires a high level of IAM compatibility.
+    # If left blank, the Storage Template will generate Storage Vaults pointing to new, separate S3
+    # buckets each time. An additional IAM policy is created for each new Storage Vault.
+    # This is preferable for platforms that have a lower level of IAM compatibility.
     # @type [String] master_bucket
     attr_accessor :master_bucket
 
@@ -28,17 +37,30 @@ module Comet
     attr_accessor :secret_key
 
     # @type [Boolean] use_object_lock__legacy__do_not_use
+    # @deprecated This member has been deprecated since Comet version 23.x.x
     attr_accessor :use_object_lock__legacy__do_not_use
 
+    # Control whether the resulting Storage Vaults are configured for Object Lock. One of the
+    # OBJECT_LOCK_ constants
     # @type [Number] object_lock_mode
     attr_accessor :object_lock_mode
 
     # @type [Number] object_lock_days
     attr_accessor :object_lock_days
 
+    # Control whether the "Allow removal of deleted files" checkbox is enabled for Storage Vaults
+    # generated from this Storage Template.
+    # When configuring a Storage Template from the Comet Server web interface, this field is set
+    # automatically for Storage Templates using Object Lock.
     # @type [Boolean] remove_deleted
     attr_accessor :remove_deleted
 
+    # Optional. The region to be used for new buckets. If blank, uses the default region for the
+    # S3-compatible provider (e.g. us-east-1).
+    # This field is available in Comet 24.3.1 and later.
+    # @type [String] region
+    attr_accessor :region
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -54,6 +76,7 @@ module Comet
       @secret_key = ''
       @object_lock_mode = 0
       @object_lock_days = 0
+      @region = ''
       @unknown_json_fields = {}
     end
 
@@ -102,6 +125,10 @@ module Comet
           @object_lock_days = v
         when 'RemoveDeleted'
           @remove_deleted = v
+        when 'Region'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @region = v
         else
           @unknown_json_fields[k] = v
         end
@@ -120,6 +147,7 @@ module Comet
       ret['ObjectLockMode'] = @object_lock_mode
       ret['ObjectLockDays'] = @object_lock_days
       ret['RemoveDeleted'] = @remove_deleted
+      ret['Region'] = @region
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/smbdestination_location.rb

@@ -0,0 +1,109 @@
+# 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
+
+  # SMBDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class SMBDestinationLocation
+
+    # @type [String] smbserver
+    attr_accessor :smbserver
+
+    # @type [String] smbshare
+    attr_accessor :smbshare
+
+    # @type [String] smbdirectory
+    attr_accessor :smbdirectory
+
+    # @type [String] smbusername
+    attr_accessor :smbusername
+
+    # @type [String] smbpassword
+    attr_accessor :smbpassword
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @smbserver = ''
+      @smbshare = ''
+      @smbdirectory = ''
+      @smbusername = ''
+      @smbpassword = ''
+      @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 'SMBServer'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @smbserver = v
+        when 'SMBShare'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @smbshare = v
+        when 'SMBDirectory'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @smbdirectory = v
+        when 'SMBUsername'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @smbusername = v
+        when 'SMBPassword'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @smbpassword = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SMBServer'] = @smbserver
+      ret['SMBShare'] = @smbshare
+      ret['SMBDirectory'] = @smbdirectory
+      ret['SMBUsername'] = @smbusername
+      ret['SMBPassword'] = @smbpassword
+      @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/source_config.rb

@@ -59,6 +59,8 @@ module Comet
     # - USE_WIN_VSS: If present, the 'Take filesystem snapshot' checkbox is checked
     # - CONFIRM_EFS: If present, the 'Dismiss EFS warning' checkbox is checked
     # - RESCAN_UNCHANGED: If present, the 'Rescan unchanged files' checkbox is checked
+    # - EXTRA_ATTRIBUTES: If present, the 'Back up extra system permissions and attributes' checkbox is
+    # checked
     #
     # For engine1/mssql, Comet understands the following EngineProp keys:
     #

data/lib/comet/models/wasabi_virtual_storage_role_settings.rb

@@ -10,8 +10,16 @@ require 'json'
 module Comet
 
   # WasabiVirtualStorageRoleSettings is a typed class wrapper around the underlying Comet Server API data structure.
+  # This is an alias type for AmazonAWSVirtualStorageRoleSettings.
   class WasabiVirtualStorageRoleSettings
 
+    # If set, the Storage Template will generate Storage Vaults pointing to a subdirectory within this
+    # bucket. A single dynamic IAM policy will cover all created Storage Vaults.
+    # This is preferable for platforms that have limits on the total number of IAM policies. However, it
+    # requires a high level of IAM compatibility.
+    # If left blank, the Storage Template will generate Storage Vaults pointing to new, separate S3
+    # buckets each time. An additional IAM policy is created for each new Storage Vault.
+    # This is preferable for platforms that have a lower level of IAM compatibility.
     # @type [String] master_bucket
     attr_accessor :master_bucket
 
@@ -22,14 +30,21 @@ module Comet
     attr_accessor :secret_key
 
     # @type [Boolean] use_object_lock__legacy__do_not_use
+    # @deprecated This member has been deprecated since Comet version 23.x.x
     attr_accessor :use_object_lock__legacy__do_not_use
 
+    # Control whether the resulting Storage Vaults are configured for Object Lock. One of the
+    # OBJECT_LOCK_ constants
     # @type [Number] object_lock_mode
     attr_accessor :object_lock_mode
 
     # @type [Number] object_lock_days
     attr_accessor :object_lock_days
 
+    # Control whether the "Allow removal of deleted files" checkbox is enabled for Storage Vaults
+    # generated from this Storage Template.
+    # When configuring a Storage Template from the Comet Server web interface, this field is set
+    # automatically for Storage Templates using Object Lock.
     # @type [Boolean] remove_deleted
     attr_accessor :remove_deleted
 

data/lib/comet_backup_ruby_sdk.rb

@@ -86,6 +86,8 @@ require_relative 'comet/models/group_policy'
 require_relative 'comet/models/hour_sched_config'
 require_relative 'comet/models/httpconnector_options'
 require_relative 'comet/models/hyper_vmachine_info'
+require_relative 'comet/models/impossible_cloud_iamtemplate_settings'
+require_relative 'comet/models/impossible_cloud_partner_template_settings'
 require_relative 'comet/models/install_creds'
 require_relative 'comet/models/install_token'
 require_relative 'comet/models/install_token_response'
@@ -101,6 +103,7 @@ require_relative 'comet/models/mssqllogin_args'
 require_relative 'comet/models/my_sqlconnection'
 require_relative 'comet/models/new_bucket_detail'
 require_relative 'comet/models/news_entry'
+require_relative 'comet/models/object_lock_storage_template_settings'
 require_relative 'comet/models/office_365connection'
 require_relative 'comet/models/office_365credential'
 require_relative 'comet/models/office_365custom_setting'
@@ -152,6 +155,7 @@ require_relative 'comet/models/session_options'
 require_relative 'comet/models/sftpdestination_location'
 require_relative 'comet/models/single_field_source'
 require_relative 'comet/models/size_measurement'
+require_relative 'comet/models/smbdestination_location'
 require_relative 'comet/models/software_build_role_options'
 require_relative 'comet/models/software_update_news_response'
 require_relative 'comet/models/source_basic_info'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.26.0
+  version: 2.27.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,8 @@ files:
 - lib/comet/models/hour_sched_config.rb
 - lib/comet/models/httpconnector_options.rb
 - lib/comet/models/hyper_vmachine_info.rb
+- lib/comet/models/impossible_cloud_iamtemplate_settings.rb
+- lib/comet/models/impossible_cloud_partner_template_settings.rb
 - lib/comet/models/install_creds.rb
 - lib/comet/models/install_token.rb
 - lib/comet/models/install_token_response.rb
@@ -179,6 +181,7 @@ files:
 - lib/comet/models/my_sqlconnection.rb
 - lib/comet/models/new_bucket_detail.rb
 - lib/comet/models/news_entry.rb
+- lib/comet/models/object_lock_storage_template_settings.rb
 - lib/comet/models/office_365connection.rb
 - lib/comet/models/office_365credential.rb
 - lib/comet/models/office_365custom_setting.rb
@@ -230,6 +233,7 @@ files:
 - lib/comet/models/sftpdestination_location.rb
 - lib/comet/models/single_field_source.rb
 - lib/comet/models/size_measurement.rb
+- lib/comet/models/smbdestination_location.rb
 - lib/comet/models/software_build_role_options.rb
 - lib/comet/models/software_update_news_response.rb
 - lib/comet/models/source_basic_info.rb