Class: AsposeCellsCloud::ExtractTextRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/requests/extract_text_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtractTextRequest

Returns a new instance of ExtractTextRequest.



48
49
50
51
52
53
54
55
56
57
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 48

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

  if attributes.has_key?(:'extractTextType')
      self.extract_text_type = attributes[:'extractTextType']
  end

  if attributes.has_key?(:'outPositionRange')
      self.out_position_range = attributes[:'outPositionRange']
  end

  if attributes.has_key?(:'beforeText')
      self.before_text = attributes[:'beforeText']
  end

  if attributes.has_key?(:'afterText')
      self.after_text = attributes[:'afterText']
  end

  if attributes.has_key?(:'beforePosition')
      self.before_position = attributes[:'beforePosition']
  end

  if attributes.has_key?(:'afterPosition')
      self.after_position = attributes[:'afterPosition']
  end

  if attributes.has_key?(:'worksheet')
      self.worksheet = attributes[:'worksheet']
  end

  if attributes.has_key?(:'range')
      self.range = attributes[:'range']
  end

  if attributes.has_key?(:'outPath')
      self.out_path = attributes[:'outPath']
  end

  if attributes.has_key?(:'outStorageName')
      self.out_storage_name = attributes[:'outStorageName']
  end

  if attributes.has_key?(:'region')
      self.region = attributes[:'region']
  end

  if attributes.has_key?(:'password')
      self.password = attributes[:'password']
  end

end

Instance Attribute Details

#after_position ⇒ Object

Returns the value of attribute after_position.



40
41
42
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 40

def after_position
  @after_position
end

#after_text ⇒ Object

Returns the value of attribute after_text.



38
39
40
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 38

def after_text
  @after_text
end

#before_position ⇒ Object

Returns the value of attribute before_position.



39
40
41
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 39

def before_position
  @before_position
end

#before_text ⇒ Object

Returns the value of attribute before_text.



37
38
39
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 37

def before_text
  @before_text
end

#extract_text_type ⇒ Object

Returns the value of attribute extract_text_type.



35
36
37
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 35

def extract_text_type
  @extract_text_type
end

#out_path ⇒ Object

Returns the value of attribute out_path.



43
44
45
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 43

def out_path
  @out_path
end

#out_position_range ⇒ Object

Returns the value of attribute out_position_range.



36
37
38
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 36

def out_position_range
  @out_position_range
end

#out_storage_name ⇒ Object

Returns the value of attribute out_storage_name.



44
45
46
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 44

def out_storage_name
  @out_storage_name
end

#password ⇒ Object

Returns the value of attribute password.



46
47
48
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 46

def password
  @password
end

#range ⇒ Object

Returns the value of attribute range.



42
43
44
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 42

def range
  @range
end

#region ⇒ Object

Returns the value of attribute region.



45
46
47
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 45

def region
  @region
end

#spreadsheet ⇒ Object

Returns the value of attribute spreadsheet.



34
35
36
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 34

def spreadsheet
  @spreadsheet
end

#worksheet ⇒ Object

Returns the value of attribute worksheet.



41
42
43
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 41

def worksheet
  @worksheet
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 108

def self.attribute_map
  {
    :'spreadsheet' => :'Spreadsheet',
    :'extract_text_type' => :'extractTextType',
    :'out_position_range' => :'outPositionRange',
    :'before_text' => :'beforeText',
    :'after_text' => :'afterText',
    :'before_position' => :'beforePosition',
    :'after_position' => :'afterPosition',
    :'worksheet' => :'worksheet',
    :'range' => :'range',
    :'out_path' => :'outPath',
    :'out_storage_name' => :'outStorageName',
    :'region' => :'region',
    :'password' => :'password'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 127

def self.swagger_types
  {
    :'spreadsheet' => :'String',
    :'extract_text_type' => :'String',
    :'out_position_range' => :'String',
    :'before_text' => :'String',
    :'after_text' => :'String',
    :'before_position' => :'Integer',
    :'after_position' => :'Integer',
    :'worksheet' => :'String',
    :'range' => :'String',
    :'out_path' => :'String',
    :'out_storage_name' => :'String',
    :'region' => :'String',
    :'password' => :'String'
  }
end

Instance Method Details

#create_http_request(api_client, opts = {}) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
200
201
202
203
204
205
206
207
208
 
# File 'lib/aspose_cells_cloud/requests/extract_text_request.rb', line 145

def create_http_request(api_client,opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug "Calling API: CellsApi.extract_text ..."
  end
  api_client.request_token_if_needed
  # verify the required parameter 'spreadsheet' is set

  if api_client.config.client_side_validation && spreadsheet.nil?
      fail ArgumentError, "Missing the required parameter 'spreadsheet' when calling CellsApi.extract_text "
  end 
  # verify the required parameter 'extract_text_type' is set

  if api_client.config.client_side_validation && extract_text_type.nil?
      fail ArgumentError, "Missing the required parameter 'extract_text_type' when calling CellsApi.extract_text "
  end 
  # verify the required parameter 'out_position_range' is set

  if api_client.config.client_side_validation && out_position_range.nil?
      fail ArgumentError, "Missing the required parameter 'out_position_range' when calling CellsApi.extract_text "
  end 

  # resource path

  local_var_path = "v4.0/cells/content/extract/text"
  # query parameters

  query_params = {}
  query_params[:'extractTextType'] = self.extract_text_type if !self.extract_text_type.nil? 
  query_params[:'outPositionRange'] = self.out_position_range if !self.out_position_range.nil? 
  query_params[:'beforeText'] = self.before_text if !self.before_text.nil? 
  query_params[:'afterText'] = self.after_text if !self.after_text.nil? 
  query_params[:'beforePosition'] = self.before_position if !self.before_position.nil? 
  query_params[:'afterPosition'] = self.after_position if !self.after_position.nil? 
  query_params[:'worksheet'] = self.worksheet if !self.worksheet.nil? 
  query_params[:'range'] = self.range if !self.range.nil? 
  query_params[:'outPath'] = self.out_path if !self.out_path.nil? 
  query_params[:'outStorageName'] = self.out_storage_name if !self.out_storage_name.nil? 
  query_params[:'region'] = self.region if !self.region.nil? 
  query_params[:'password'] = self.password if !self.password.nil? 

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters

  form_params = {}
  post_body = nil 
  header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
  if !spreadsheet.empty? && File.exist?(spreadsheet )
      form_params[File.basename(spreadsheet)] =  ::File.open(spreadsheet,"r")   
  end 

  #auth_names = []

  auth_names = ['JWT']
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Specification.Name>Api.extract_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end