comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/b2destination_location.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# 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
+
+  # B2DestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class B2DestinationLocation
+
+    # @type [String] account_id
+    attr_accessor :account_id
+
+    # @type [String] key
+    attr_accessor :key
+
+    # @type [String] bucket
+    attr_accessor :bucket
+
+    # @type [String] prefix
+    attr_accessor :prefix
+
+    # @type [Number] max_connections
+    # @deprecated This member has been deprecated since Comet version 21.9.7
+    attr_accessor :max_connections
+
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @account_id = ''
+      @key = ''
+      @bucket = ''
+      @prefix = ''
+      @max_connections = 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 'AccountID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @account_id = v
+        when 'Key'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @key = v
+        when 'Bucket'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @bucket = v
+        when 'Prefix'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @prefix = v
+        when 'MaxConnections'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @max_connections = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @account_id.nil?
+        ret['AccountID'] = @account_id
+      end
+      unless @key.nil?
+        ret['Key'] = @key
+      end
+      unless @bucket.nil?
+        ret['Bucket'] = @bucket
+      end
+      unless @prefix.nil?
+        ret['Prefix'] = @prefix
+      end
+      unless @max_connections.nil?
+        ret['MaxConnections'] = @max_connections
+      end
+      unless @hide_deleted_files.nil?
+        ret['HideDeletedFiles'] = @hide_deleted_files
+      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/models/b2storage_extra_info.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# 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
+
+  # B2StorageExtraInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class B2StorageExtraInfo
+
+    # @type [Hash{Number => Comet::B2TransactionTotals}] total_transactions_in_time_interval
+    attr_accessor :total_transactions_in_time_interval
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @total_transactions_in_time_interval = {}
+      @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 'TotalTransactionsInTimeInterval'
+          @total_transactions_in_time_interval = {}
+          if v.nil?
+            @total_transactions_in_time_interval = {}
+          else
+            v.each do |k1, v1|
+              @total_transactions_in_time_interval[k1] = Comet::B2TransactionTotals.new
+              @total_transactions_in_time_interval[k1].from_hash(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 = {}
+      ret['TotalTransactionsInTimeInterval'] = @total_transactions_in_time_interval
+      @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/models/b2transaction_totals.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# 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
+
+  # B2TransactionTotals is a typed class wrapper around the underlying Comet Server API data structure.
+  class B2TransactionTotals
+
+    # @type [Number] class_a
+    attr_accessor :class_a
+
+    # @type [Number] class_b
+    attr_accessor :class_b
+
+    # @type [Number] class_c
+    attr_accessor :class_c
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @class_a = 0
+      @class_b = 0
+      @class_c = 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 'ClassA'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @class_a = v
+        when 'ClassB'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @class_b = v
+        when 'ClassC'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @class_c = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ClassA'] = @class_a
+      ret['ClassB'] = @class_b
+      ret['ClassC'] = @class_c
+      @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/models/b2virtual_storage_role_settings.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# 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
+
+  # B2VirtualStorageRoleSettings is a typed class wrapper around the underlying Comet Server API data structure.
+  class B2VirtualStorageRoleSettings
+
+    # @type [String] master_bucket
+    attr_accessor :master_bucket
+
+    # @type [String] key_id
+    attr_accessor :key_id
+
+    # @type [String] app_key
+    attr_accessor :app_key
+
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @master_bucket = ''
+      @key_id = ''
+      @app_key = ''
+      @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 'MasterBucket'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @master_bucket = v
+        when 'KeyID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @key_id = v
+        when 'AppKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @app_key = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['MasterBucket'] = @master_bucket
+      ret['KeyID'] = @key_id
+      ret['AppKey'] = @app_key
+      ret['HideDeletedFiles'] = @hide_deleted_files
+      @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/models/backup_job_advanced_options.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# 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
+
+  # BackupJobAdvancedOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupJobAdvancedOptions
+
+    # @type [Boolean] skip_already_running
+    attr_accessor :skip_already_running
+
+    # @type [Number] stop_after
+    attr_accessor :stop_after
+
+    # @type [Number] limit_vault_speed_bps
+    attr_accessor :limit_vault_speed_bps
+
+    # @type [Boolean] reduce_disk_concurrency
+    attr_accessor :reduce_disk_concurrency
+
+    # @type [Boolean] use_on_disk_indexes
+    attr_accessor :use_on_disk_indexes
+
+    # @type [Boolean] allow_zero_files_success
+    attr_accessor :allow_zero_files_success
+
+    # @type [Number] auto_retention_level
+    attr_accessor :auto_retention_level
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @stop_after = 0
+      @limit_vault_speed_bps = 0
+      @auto_retention_level = 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 'SkipAlreadyRunning'
+          @skip_already_running = v
+        when 'StopAfter'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @stop_after = v
+        when 'LimitVaultSpeedBps'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @limit_vault_speed_bps = v
+        when 'ReduceDiskConcurrency'
+          @reduce_disk_concurrency = v
+        when 'UseOnDiskIndexes'
+          @use_on_disk_indexes = v
+        when 'AllowZeroFilesSuccess'
+          @allow_zero_files_success = v
+        when 'AutoRetentionLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @auto_retention_level = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SkipAlreadyRunning'] = @skip_already_running
+      ret['StopAfter'] = @stop_after
+      ret['LimitVaultSpeedBps'] = @limit_vault_speed_bps
+      ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
+      ret['UseOnDiskIndexes'] = @use_on_disk_indexes
+      ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
+      ret['AutoRetentionLevel'] = @auto_retention_level
+      @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