class AsposeDiagramCloud::PdfEncryptionDetails
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 49 def self.attribute_map { :'permissions' => :'Permissions', :'encryption_algorithm' => :'EncryptionAlgorithm', :'user_password' => :'UserPassword', :'owner_password' => :'OwnerPassword' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 70 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'Permissions') self.permissions = attributes[:'Permissions'] end if attributes.has_key?(:'EncryptionAlgorithm') self.encryption_algorithm = attributes[:'EncryptionAlgorithm'] end if attributes.has_key?(:'UserPassword') self.user_password = attributes[:'UserPassword'] end if attributes.has_key?(:'OwnerPassword') self.owner_password = attributes[:'OwnerPassword'] end end
Attribute type mapping.
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 59 def self.swagger_types { :'permissions' => :'String', :'encryption_algorithm' => :'String', :'user_password' => :'String', :'owner_password' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 133 def ==(o) return true if self.equal?(o) self.class == o.class && permissions == o.permissions && encryption_algorithm == o.encryption_algorithm && user_password == o.user_password && owner_password == o.owner_password end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 178 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = AsposeDiagramCloud.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 244 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 157 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] encryption_algorithm
Object to be assigned
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 123 def encryption_algorithm=(encryption_algorithm) validator = EnumAttributeValidator.new('String', ["RC4_40", "RC4_128"]) unless validator.valid?(encryption_algorithm) fail ArgumentError, "invalid value for 'encryption_algorithm', must be one of #{validator.allowable_values}." end @encryption_algorithm = encryption_algorithm end
@see the `==` method @param [Object] Object to be compared
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 144 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 150 def hash [permissions, encryption_algorithm, user_password, owner_password].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 96 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] permissions Object to be assigned
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 113 def permissions=(permissions) validator = EnumAttributeValidator.new('String', ["DisallowAll", "Printing", "ModifyContents", "ContentCopy", "ModifyAnnotations", "FillIn", "ContentCopyForAccessibility", "DocumentAssembly", "HighResolutionPrinting", "AllowAll"]) unless validator.valid?(permissions) fail ArgumentError, "invalid value for 'permissions', must be one of #{validator.allowable_values}." end @permissions = permissions end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 230 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 218 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/AsposeDiagramCloud/models/pdf_encryption_details.rb, line 103 def valid? permissions_validator = EnumAttributeValidator.new('String', ["DisallowAll", "Printing", "ModifyContents", "ContentCopy", "ModifyAnnotations", "FillIn", "ContentCopyForAccessibility", "DocumentAssembly", "HighResolutionPrinting", "AllowAll"]) return false unless permissions_validator.valid?(@permissions) encryption_algorithm_validator = EnumAttributeValidator.new('String', ["RC4_40", "RC4_128"]) return false unless encryption_algorithm_validator.valid?(@encryption_algorithm) return true end