comet_backup_ruby_sdk 1.13.0 → 2.0.0

data/lib/comet/models/replica_server.rb

@@ -0,0 +1,187 @@
+# 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
+
+  # ReplicaServer is a typed class wrapper around the underlying Comet Server API data structure.
+  class ReplicaServer
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [String] remote_address
+    attr_accessor :remote_address
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
+    attr_accessor :ldap
+
+    # @type [Comet::B2VirtualStorageRoleSettings] b2
+    attr_accessor :b2
+
+    # @type [Comet::WasabiVirtualStorageRoleSettings] wasabi
+    attr_accessor :wasabi
+
+    # @type [Comet::CustomRemoteBucketSettings] custom
+    attr_accessor :custom
+
+    # @type [Comet::S3GenericVirtualStorageRole] s3
+    attr_accessor :s3
+
+    # Amazon AWS - Virtual Storage Role
+    # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
+    attr_accessor :aws
+
+    # @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
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @type = ''
+      @description = ''
+      @remote_address = ''
+      @username = ''
+      @password = ''
+      @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+      @b2 = Comet::B2VirtualStorageRoleSettings.new
+      @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
+      @custom = Comet::CustomRemoteBucketSettings.new
+      @s3 = Comet::S3GenericVirtualStorageRole.new
+      @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+      @replica_deletion_strategy = ''
+      @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 'Type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'RemoteAddress'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @remote_address = v
+        when 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @password = v
+        when 'LDAP'
+          @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+          @ldap.from_hash(v)
+        when 'B2'
+          @b2 = Comet::B2VirtualStorageRoleSettings.new
+          @b2.from_hash(v)
+        when 'Wasabi'
+          @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
+          @wasabi.from_hash(v)
+        when 'Custom'
+          @custom = Comet::CustomRemoteBucketSettings.new
+          @custom.from_hash(v)
+        when 'S3'
+          @s3 = Comet::S3GenericVirtualStorageRole.new
+          @s3.from_hash(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
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Type'] = @type
+      ret['Description'] = @description
+      unless @remote_address.nil?
+        ret['RemoteAddress'] = @remote_address
+      end
+      unless @username.nil?
+        ret['Username'] = @username
+      end
+      unless @password.nil?
+        ret['Password'] = @password
+      end
+      unless @ldap.nil?
+        ret['LDAP'] = @ldap
+      end
+      unless @b2.nil?
+        ret['B2'] = @b2
+      end
+      unless @wasabi.nil?
+        ret['Wasabi'] = @wasabi
+      end
+      unless @custom.nil?
+        ret['Custom'] = @custom
+      end
+      unless @s3.nil?
+        ret['S3'] = @s3
+      end
+      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
+      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/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'
 

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'
 

data/lib/comet/models/s3generic_virtual_storage_role.rb

@@ -0,0 +1,109 @@
+# 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
+
+  # S3GenericVirtualStorageRole is a typed class wrapper around the underlying Comet Server API data structure.
+  class S3GenericVirtualStorageRole
+
+    # @type [String] s3endpoint
+    attr_accessor :s3endpoint
+
+    # @type [String] iamendpoint
+    attr_accessor :iamendpoint
+
+    # @type [String] master_bucket
+    attr_accessor :master_bucket
+
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # @type [String] secret_key
+    attr_accessor :secret_key
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @s3endpoint = ''
+      @iamendpoint = ''
+      @master_bucket = ''
+      @access_key = ''
+      @secret_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 'S3Endpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3endpoint = v
+        when 'IAMEndpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @iamendpoint = v
+        when 'MasterBucket'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @master_bucket = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
+        when 'SecretKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @secret_key = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['S3Endpoint'] = @s3endpoint
+      ret['IAMEndpoint'] = @iamendpoint
+      ret['MasterBucket'] = @master_bucket
+      ret['AccessKey'] = @access_key
+      ret['SecretKey'] = @secret_key
+      @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/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/comet/models/self_backup_options.rb

@@ -0,0 +1,79 @@
+# 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
+
+  # SelfBackupOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class SelfBackupOptions
+
+    # @type [Array<Comet::SelfBackupTarget>] targets
+    attr_accessor :targets
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @targets = []
+      @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 'Targets'
+          if v.nil?
+            @targets = []
+          else
+            @targets = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @targets[i1] = Comet::SelfBackupTarget.new
+              @targets[i1].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['Targets'] = @targets
+      @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/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