Class: AsposeWordsCloud::ProtectionRequestV2

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/protection_request_v2.rb

Overview

Request on changing of protection.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionRequestV2

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 79

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.key?(:'ProtectionPassword')
    self.protection_password = attributes[:'ProtectionPassword']
  end

  if attributes.key?(:'ProtectionType')
    self.protection_type = attributes[:'ProtectionType']
  end
end

Instance Attribute Details

#protection_password ⇒ Object

Gets or sets the new password for the document protection. This property is required, but empty value is allowed.



34
35
36
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 34

def protection_password
  @protection_password
end

#protection_type ⇒ Object

Gets or sets the new type of the document protection.



37
38
39
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 37

def protection_type
  @protection_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



62
63
64
65
66
67
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 62

def self.attribute_map
  {
    :'protection_password' => :'ProtectionPassword',
    :'protection_type' => :'ProtectionType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 70

def self.swagger_types
  {
    :'protection_password' => :'String',
    :'protection_type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 120

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      protection_password == other.protection_password &&
      protection_type == other.protection_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 164

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 235

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 142

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

#collectFilesContent(resultFilesContent) ⇒ Object 



249
250
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 249

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


129
130
131
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 135

def hash
  [protection_password, protection_type].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 215

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 221

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



209
210
211
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 209

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



96
97
98
99
100
101
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 96

def valid?
  protection_type_validator = EnumAttributeValidator.new('String', ["AllowOnlyRevisions", "AllowOnlyComments", "AllowOnlyFormFields", "ReadOnly", "NoProtection"])
  return false unless protection_type_validator.valid?(@protection_type)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


252
253
254
255
 
# File 'lib/aspose_words_cloud/models/protection_request_v2.rb', line 252

def validate()
  raise ArgumentError, 'Property protection_password in ProtectionRequestV2 is required.' if self.protection_password.nil?
  raise ArgumentError, 'Property protection_type in ProtectionRequestV2 is required.' if self.protection_type.nil?
end