comet_backup_ruby_sdk 1.14.0 → 2.1.0

data/lib/comet/models/authentication_role_options.rb

@@ -0,0 +1,149 @@
+# 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
+
+  # AuthenticationRoleOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class AuthenticationRoleOptions
+
+    # @type [Boolean] role_enabled
+    attr_accessor :role_enabled
+
+    # @type [Number] database_check_level
+    attr_accessor :database_check_level
+
+    # @type [Boolean] generate_missed_backup_events
+    attr_accessor :generate_missed_backup_events
+
+    # @type [Number] no_missed_backup_events_before
+    attr_accessor :no_missed_backup_events_before
+
+    # @type [Boolean] generate_scheduled_emails
+    attr_accessor :generate_scheduled_emails
+
+    # @type [Number] prune_logs_after_days
+    attr_accessor :prune_logs_after_days
+
+    # @type [Array<Comet::RemoteStorageOption>] remote_storage
+    attr_accessor :remote_storage
+
+    # @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
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @database_check_level = 0
+      @no_missed_backup_events_before = 0
+      @prune_logs_after_days = 0
+      @remote_storage = []
+      @replicate_to = []
+      @global_overrides = Comet::GlobalOverrideOptions.new
+      @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 'RoleEnabled'
+          @role_enabled = v
+        when 'DatabaseCheckLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @database_check_level = v
+        when 'GenerateMissedBackupEvents'
+          @generate_missed_backup_events = v
+        when 'NoMissedBackupEventsBefore'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @no_missed_backup_events_before = v
+        when 'GenerateScheduledEmails'
+          @generate_scheduled_emails = v
+        when 'PruneLogsAfterDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @prune_logs_after_days = v
+        when 'RemoteStorage'
+          if v.nil?
+            @remote_storage = []
+          else
+            @remote_storage = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @remote_storage[i1] = Comet::RemoteStorageOption.new
+              @remote_storage[i1].from_hash(v1)
+            end
+          end
+        when 'ReplicateTo'
+          if v.nil?
+            @replicate_to = []
+          else
+            @replicate_to = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @replicate_to[i1] = Comet::ReplicaServer.new
+              @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
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['RoleEnabled'] = @role_enabled
+      ret['DatabaseCheckLevel'] = @database_check_level
+      ret['GenerateMissedBackupEvents'] = @generate_missed_backup_events
+      ret['NoMissedBackupEventsBefore'] = @no_missed_backup_events_before
+      ret['GenerateScheduledEmails'] = @generate_scheduled_emails
+      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
+      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/available_download.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/azure_destination_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'
 

data/lib/comet/models/b2destination_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'
 

data/lib/comet/models/b2storage_extra_info.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/b2transaction_totals.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/b2virtual_storage_role_settings.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/backup_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'
 

data/lib/comet/models/backup_job_detail.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/backup_job_progress.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/backup_rule_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'
 

data/lib/comet/models/backup_rule_event_triggers.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/branding_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'
 
@@ -53,6 +51,9 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # @type [Number] build_mode
+    attr_accessor :build_mode
+
     # @type [String] path_ico_file
     attr_accessor :path_ico_file
 
@@ -125,6 +126,7 @@ module Comet
       @default_login_server_url = ''
       @tile_background_color = ''
       @account_register_url = ''
+      @build_mode = 0
       @path_ico_file = ''
       @path_icns_file = ''
       @path_menu_bar_icns_file = ''
@@ -205,6 +207,10 @@ module Comet
           @account_register_url = v
         when 'HideBackgroundLogo'
           @hide_background_logo = v
+        when 'BuildMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @build_mode = v
         when 'PathIcoFile'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -298,6 +304,7 @@ module Comet
       ret['TileBackgroundColor'] = @tile_background_color
       ret['AccountRegisterURL'] = @account_register_url
       ret['HideBackgroundLogo'] = @hide_background_logo
+      ret['BuildMode'] = @build_mode
       ret['PathIcoFile'] = @path_ico_file
       ret['PathIcnsFile'] = @path_icns_file
       ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file

data/lib/comet/models/branding_properties.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 [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # @type [Number] build_mode
+    attr_accessor :build_mode
+
     # @type [String] path_ico_file
     attr_accessor :path_ico_file
 
@@ -106,6 +107,7 @@ module Comet
       @default_login_server_url = ''
       @tile_background_color = ''
       @account_register_url = ''
+      @build_mode = 0
       @path_ico_file = ''
       @path_icns_file = ''
       @path_menu_bar_icns_file = ''
@@ -168,6 +170,10 @@ module Comet
           @account_register_url = v
         when 'HideBackgroundLogo'
           @hide_background_logo = v
+        when 'BuildMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @build_mode = v
         when 'PathIcoFile'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -256,6 +262,7 @@ module Comet
       ret['TileBackgroundColor'] = @tile_background_color
       ret['AccountRegisterURL'] = @account_register_url
       ret['HideBackgroundLogo'] = @hide_background_logo
+      ret['BuildMode'] = @build_mode
       ret['PathIcoFile'] = @path_ico_file
       ret['PathIcnsFile'] = @path_icns_file
       ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file

data/lib/comet/models/browse_disk_drives_response.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/browse_edbresponse.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/browse_hvresponse.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/browse_office_365list_virtual_accounts_response.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/browse_office_365objects_response.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/browse_sqlserver_response.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/browse_vssresponse.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/bucket_properties.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/bucket_usage_info.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'
 
@@ -14,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
 
@@ -28,6 +29,7 @@ module Comet
     end
 
     def clear
+      @access_key = ''
       @exists_on_servers = []
       @in_use_by = []
       @unknown_json_fields = {}
@@ -46,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 = []
@@ -76,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/comet_apiresponse_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/comet_destination_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'
 

data/lib/comet/models/constellation_check_report.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'