lib/comet/models/local_destination_location.rb
# 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 # LocalDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure. class LocalDestinationLocation # @type [String] localcopy_path attr_accessor :localcopy_path # If logging in to a Windows network share (SMB/CIFS) is required, enter the username here. # @type [String] localcopy_win_smbusername attr_accessor :localcopy_win_smbusername # If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The # password may be hashed as per the LocalcopyWinSMBPasswordFormat field. # @type [String] localcopy_win_smbpassword attr_accessor :localcopy_win_smbpassword # One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword # field. # @type [Number] localcopy_win_smbpassword_format attr_accessor :localcopy_win_smbpassword_format # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations attr_accessor :unknown_json_fields def initialize clear end def clear @localcopy_path = '' @localcopy_win_smbusername = '' @localcopy_win_smbpassword = '' @localcopy_win_smbpassword_format = 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 'LocalcopyPath' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @localcopy_path = v when 'LocalcopyWinSMBUsername' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @localcopy_win_smbusername = v when 'LocalcopyWinSMBPassword' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @localcopy_win_smbpassword = v when 'LocalcopyWinSMBPasswordFormat' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @localcopy_win_smbpassword_format = v else @unknown_json_fields[k] = v end end end # @return [Hash] The complete object as a Ruby hash def to_hash ret = {} ret['LocalcopyPath'] = @localcopy_path ret['LocalcopyWinSMBUsername'] = @localcopy_win_smbusername ret['LocalcopyWinSMBPassword'] = @localcopy_win_smbpassword ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format @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