comet_backup_ruby_sdk 1.14.0 → 2.1.0

data/lib/{models/remote_storage_option.rb → comet/models/replica_server.rb}

@@ -1,18 +1,16 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 
 module Comet
 
-  # RemoteStorageOption is a typed class wrapper around the underlying Comet Server API data structure.
-  class RemoteStorageOption
+  # ReplicaServer is a typed class wrapper around the underlying Comet Server API data structure.
+  class ReplicaServer
 
     # @type [String] type
     attr_accessor :type
@@ -44,14 +42,12 @@ module Comet
     # @type [Comet::S3GenericVirtualStorageRole] s3
     attr_accessor :s3
 
-    # @type [Boolean] storage_limit_enabled
-    attr_accessor :storage_limit_enabled
+    # Amazon AWS - Virtual Storage Role
+    # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
+    attr_accessor :aws
 
-    # @type [Number] storage_limit_bytes
-    attr_accessor :storage_limit_bytes
-
-    # @type [Boolean] rebrand_storage
-    attr_accessor :rebrand_storage
+    # @type [String] replica_deletion_strategy
+    attr_accessor :replica_deletion_strategy
 
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
@@ -71,7 +67,8 @@ module Comet
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
       @s3 = Comet::S3GenericVirtualStorageRole.new
-      @storage_limit_bytes = 0
+      @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+      @replica_deletion_strategy = ''
       @unknown_json_fields = {}
     end
 
@@ -123,14 +120,13 @@ module Comet
         when 'S3'
           @s3 = Comet::S3GenericVirtualStorageRole.new
           @s3.from_hash(v)
-        when 'StorageLimitEnabled'
-          @storage_limit_enabled = v
-        when 'StorageLimitBytes'
-          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
-
-          @storage_limit_bytes = v
-        when 'RebrandStorage'
-          @rebrand_storage = v
+        when 'AWS'
+          @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+          @aws.from_hash(v)
+        when 'ReplicaDeletionStrategy'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @replica_deletion_strategy = v
         else
           @unknown_json_fields[k] = v
         end
@@ -166,9 +162,12 @@ module Comet
       unless @s3.nil?
         ret['S3'] = @s3
       end
-      ret['StorageLimitEnabled'] = @storage_limit_enabled
-      ret['StorageLimitBytes'] = @storage_limit_bytes
-      ret['RebrandStorage'] = @rebrand_storage
+      unless @aws.nil?
+        ret['AWS'] = @aws
+      end
+      unless @replica_deletion_strategy.nil?
+        ret['ReplicaDeletionStrategy'] = @replica_deletion_strategy
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/replicator_state_apiresponse.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/request_storage_vault_response_message.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/restore_job_advanced_options.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 
@@ -20,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
 
@@ -70,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'
@@ -105,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/retention_policy.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/retention_range.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/s3destination_location.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 
@@ -32,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
 
@@ -48,6 +49,7 @@ module Comet
       @s3secret_key = ''
       @s3bucket_name = ''
       @s3subdir = ''
+      @s3custom_region = ''
       @unknown_json_fields = {}
     end
 
@@ -86,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
@@ -103,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/{models → comet/models}/s3generic_virtual_storage_role.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/schedule_config.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 
@@ -38,6 +36,9 @@ module Comet
     # @type [Comet::DaysOfWeekConfig] days_select
     attr_accessor :days_select
 
+    # @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
 
@@ -52,6 +53,7 @@ module Comet
       @from_time = Comet::HourSchedConfig.new
       @to_time = Comet::HourSchedConfig.new
       @days_select = Comet::DaysOfWeekConfig.new
+      @random_delay_secs = 0
       @unknown_json_fields = {}
     end
 
@@ -93,6 +95,10 @@ module Comet
         when 'DaysSelect'
           @days_select = Comet::DaysOfWeekConfig.new
           @days_select.from_hash(v)
+        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
@@ -112,6 +118,9 @@ module Comet
       ret['ToTime'] = @to_time
       ret['RestrictDays'] = @restrict_days
       ret['DaysSelect'] = @days_select
+      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/search_clause.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/{models/spanned_storage_extra_info.rb → comet/models/self_backup_options.rb}

@@ -1,20 +1,18 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 
 module Comet
 
-  # SpannedStorageExtraInfo is a typed class wrapper around the underlying Comet Server API data structure.
-  class SpannedStorageExtraInfo
+  # SelfBackupOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class SelfBackupOptions
 
-    # @type [Array<Comet::StorageFreeSpaceInfo>] targets
+    # @type [Array<Comet::SelfBackupTarget>] targets
     attr_accessor :targets
 
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
@@ -48,7 +46,7 @@ module Comet
           else
             @targets = Array.new(v.length)
             v.each_with_index do |v1, i1|
-              @targets[i1] = Comet::StorageFreeSpaceInfo.new
+              @targets[i1] = Comet::SelfBackupTarget.new
               @targets[i1].from_hash(v1)
             end
           end

data/lib/comet/models/self_backup_statistics.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/self_backup_target.rb

@@ -0,0 +1,137 @@
+# 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
+
+  # SelfBackupTarget is a typed class wrapper around the underlying Comet Server API data structure.
+  class SelfBackupTarget
+
+    # @type [Comet::DestinationLocation] location
+    attr_accessor :location
+
+    # @type [Array<Comet::ScheduleConfig>] schedule
+    attr_accessor :schedule
+
+    # @type [String] schedule_timezone
+    attr_accessor :schedule_timezone
+
+    # @type [Comet::RetentionPolicy] retention_policy
+    attr_accessor :retention_policy
+
+    # @type [String] encryption_key
+    attr_accessor :encryption_key
+
+    # @type [Number] encryption_key_format
+    attr_accessor :encryption_key_format
+
+    # @type [Number] compression
+    attr_accessor :compression
+
+    # @type [Boolean] exclude_jobs_db
+    attr_accessor :exclude_jobs_db
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @location = Comet::DestinationLocation.new
+      @schedule = []
+      @schedule_timezone = ''
+      @retention_policy = Comet::RetentionPolicy.new
+      @encryption_key = ''
+      @encryption_key_format = 0
+      @compression = 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 'Location'
+          @location = Comet::DestinationLocation.new
+          @location.from_hash(v)
+        when 'Schedule'
+          if v.nil?
+            @schedule = []
+          else
+            @schedule = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @schedule[i1] = Comet::ScheduleConfig.new
+              @schedule[i1].from_hash(v1)
+            end
+          end
+        when 'ScheduleTimezone'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @schedule_timezone = v
+        when 'RetentionPolicy'
+          @retention_policy = Comet::RetentionPolicy.new
+          @retention_policy.from_hash(v)
+        when 'EncryptionKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @encryption_key = v
+        when 'EncryptionKeyFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @encryption_key_format = v
+        when 'Compression'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @compression = v
+        when 'ExcludeJobsDB'
+          @exclude_jobs_db = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Location'] = @location
+      ret['Schedule'] = @schedule
+      ret['ScheduleTimezone'] = @schedule_timezone
+      ret['RetentionPolicy'] = @retention_policy
+      ret['EncryptionKey'] = @encryption_key
+      ret['EncryptionKeyFormat'] = @encryption_key_format
+      ret['Compression'] = @compression
+      ret['ExcludeJobsDB'] = @exclude_jobs_db
+      @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