comet_backup_ruby_sdk 2.26.0 → 2.27.0

data/lib/comet/models/impossible_cloud_iamtemplate_settings.rb

@@ -0,0 +1,131 @@
+# 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
+
+  # ImpossibleCloudIAMTemplateSettings is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.3.1 and later.
+  class ImpossibleCloudIAMTemplateSettings
+
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # @type [String] secret_key
+    attr_accessor :secret_key
+
+    # Optional. The region for both IAM communication and for provisioning new buckets. If blank, uses
+    # the default region for Impossible Cloud (eu-central-2).
+    # @type [String] region
+    attr_accessor :region
+
+    # @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
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @access_key = ''
+      @secret_key = ''
+      @region = ''
+      @object_lock_mode = 0
+      @object_lock_days = 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 '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
+        when 'Region'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @region = v
+        when 'UseObjectLock'
+          @use_object_lock__legacy__do_not_use = v
+        when 'ObjectLockMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_mode = v
+        when 'ObjectLockDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_days = v
+        when 'RemoveDeleted'
+          @remove_deleted = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['AccessKey'] = @access_key
+      ret['SecretKey'] = @secret_key
+      ret['Region'] = @region
+      ret['UseObjectLock'] = @use_object_lock__legacy__do_not_use
+      ret['ObjectLockMode'] = @object_lock_mode
+      ret['ObjectLockDays'] = @object_lock_days
+      ret['RemoveDeleted'] = @remove_deleted
+      @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/impossible_cloud_partner_template_settings.rb

@@ -0,0 +1,85 @@
+# 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
+
+  # ImpossibleCloudPartnerTemplateSettings is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.3.1 and later.
+  class ImpossibleCloudPartnerTemplateSettings
+
+    # Optional. The region for your Partner console and for provisioning new buckets. If blank, uses the
+    # default region for Impossible Cloud (eu-central-2).
+    # @type [String] region
+    attr_accessor :region
+
+    # @type [String] access_key
+    attr_accessor :access_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
+      @region = ''
+      @access_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 'Region'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @region = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_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['Region'] = @region
+      ret['AccessKey'] = @access_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/object_lock_storage_template_settings.rb

@@ -0,0 +1,101 @@
+# 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
+
+  # ObjectLockStorageTemplateSettings is a typed class wrapper around the underlying Comet Server API data structure.
+  class ObjectLockStorageTemplateSettings
+
+    # @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
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @object_lock_mode = 0
+      @object_lock_days = 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 'UseObjectLock'
+          @use_object_lock__legacy__do_not_use = v
+        when 'ObjectLockMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_mode = v
+        when 'ObjectLockDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_days = v
+        when 'RemoveDeleted'
+          @remove_deleted = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['UseObjectLock'] = @use_object_lock__legacy__do_not_use
+      ret['ObjectLockMode'] = @object_lock_mode
+      ret['ObjectLockDays'] = @object_lock_days
+      ret['RemoveDeleted'] = @remove_deleted
+      @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/remote_server_address.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 [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -73,6 +89,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
       @unknown_json_fields = {}
     end
 
@@ -133,6 +151,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)
         else
           @unknown_json_fields[k] = v
         end
@@ -177,6 +201,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
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/remote_storage_option.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 [Boolean] storage_limit_enabled
     attr_accessor :storage_limit_enabled
 
@@ -82,6 +98,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
       @storage_limit_bytes = 0
       @unknown_json_fields = {}
     end
@@ -143,6 +161,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 'StorageLimitEnabled'
           @storage_limit_enabled = v
         when 'StorageLimitBytes'
@@ -195,6 +219,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
       ret['StorageLimitEnabled'] = @storage_limit_enabled
       ret['StorageLimitBytes'] = @storage_limit_bytes
       ret['RebrandStorage'] = @rebrand_storage