Class: CloudmersiveConvertApiClient::InsertDocxTablesRequest
- Inherits:
-
Object
- Object
- CloudmersiveConvertApiClient::InsertDocxTablesRequest
- Defined in:
- lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb
Overview
Input to a Insert Tables request
Instance Attribute Summary collapse
-
#input_file_bytes ⇒ Object
Optional: Bytes of the input file to operate on.
-
#input_file_url ⇒ Object
Optional: URL of a file to operate on as input.
-
#insert_path ⇒ Object
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.
-
#insert_placement ⇒ Object
Optional; default is DocumentEnd.
-
#table_to_insert ⇒ Object
Table you would like to insert.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ InsertDocxTablesRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ InsertDocxTablesRequest
Initializes the object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 58 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?(:'InputFileBytes') self.input_file_bytes = attributes[:'InputFileBytes'] end if attributes.has_key?(:'InputFileUrl') self.input_file_url = attributes[:'InputFileUrl'] end if attributes.has_key?(:'TableToInsert') self.table_to_insert = attributes[:'TableToInsert'] end if attributes.has_key?(:'InsertPlacement') self.insert_placement = attributes[:'InsertPlacement'] end if attributes.has_key?(:'InsertPath') self.insert_path = attributes[:'InsertPath'] end end |
Instance Attribute Details
#input_file_bytes ⇒ Object
Optional: Bytes of the input file to operate on
19 20 21 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 19 def input_file_bytes @input_file_bytes end |
#input_file_url ⇒ Object
Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
22 23 24 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 22 def input_file_url @input_file_url end |
#insert_path ⇒ Object
Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
31 32 33 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 31 def insert_path @insert_path end |
#insert_placement ⇒ Object
Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
28 29 30 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 28 def insert_placement @insert_placement end |
#table_to_insert ⇒ Object
Table you would like to insert
25 26 27 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 25 def table_to_insert @table_to_insert end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
35 36 37 38 39 40 41 42 43 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 35 def self.attribute_map { :'input_file_bytes' => :'InputFileBytes', :'input_file_url' => :'InputFileUrl', :'table_to_insert' => :'TableToInsert', :'insert_placement' => :'InsertPlacement', :'insert_path' => :'InsertPath' } end |
.swagger_types ⇒ Object
Attribute type mapping.
46 47 48 49 50 51 52 53 54 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 46 def self.swagger_types { :'input_file_bytes' => :'String', :'input_file_url' => :'String', :'table_to_insert' => :'DocxTable', :'insert_placement' => :'String', :'insert_path' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
117 118 119 120 121 122 123 124 125 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 117 def ==(o) return true if self.equal?(o) self.class == o.class && input_file_bytes == o.input_file_bytes && input_file_url == o.input_file_url && table_to_insert == o.table_to_insert && insert_placement == o.insert_placement && insert_path == o.insert_path end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
163 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 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 163 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 = CloudmersiveConvertApiClient.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
229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 229 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
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.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 |
#eql?(o) ⇒ Boolean
129 130 131 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 129 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
135 136 137 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 135 def hash [input_file_bytes, input_file_url, table_to_insert, insert_placement, insert_path].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
88 89 90 91 92 93 94 95 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 88 def list_invalid_properties invalid_properties = Array.new if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/) invalid_properties.push("invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
209 210 211 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 209 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
215 216 217 218 219 220 221 222 223 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 215 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
203 204 205 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 203 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
99 100 101 102 |
# File 'lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb', line 99 def valid? return false if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/) return true end |