Class: AsposeWordsCloud::MoveFileRequest

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

Overview

Request model for move_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dest_path:, src_path:, src_storage_name: nil, dest_storage_name: nil, version_id: nil) ⇒ MoveFileRequest

Initializes a new instance.

Parameters:

  • dest_path —

    Destination file path e.g. ‘/dest.ext’.

  • src_path —

    Source file’s path e.g. ‘/Folder 1/file.ext’ or ‘/Bucket/Folder 1/file.ext’.

  • src_storage_name (defaults to: nil) —

    Source storage name.

  • dest_storage_name (defaults to: nil) —

    Destination storage name.

  • version_id (defaults to: nil) —

    File version ID to move.



55
56
57
58
59
60
61
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 55

def initialize(dest_path:, src_path:, src_storage_name: nil, dest_storage_name: nil, version_id: nil)
  self.dest_path = dest_path
  self.src_path = src_path
  self.src_storage_name = src_storage_name
  self.dest_storage_name = dest_storage_name
  self.version_id = version_id
end

Instance Attribute Details

#dest_path ⇒ Object

Destination file path e.g. ‘/dest.ext’.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 33

def dest_path
  @dest_path
end

#dest_storage_name ⇒ Object

Destination storage name.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 42

def dest_storage_name
  @dest_storage_name
end

#src_path ⇒ Object

Source file’s path e.g. ‘/Folder 1/file.ext’ or ‘/Bucket/Folder 1/file.ext’.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 36

def src_path
  @src_path
end

#src_storage_name ⇒ Object

Source storage name.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 39

def src_storage_name
  @src_storage_name
end

#version_id ⇒ Object

File version ID to move.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 45

def version_id
  @version_id
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 119

def create_http_request(api_client)
  # verify the required parameter 'dest_path' is set
  raise ArgumentError, 'Missing the required parameter dest_path when calling WordsApi.move_file' if api_client.config.client_side_validation && self.dest_path.nil?
  # verify the required parameter 'src_path' is set
  raise ArgumentError, 'Missing the required parameter src_path when calling WordsApi.move_file' if api_client.config.client_side_validation && self.src_path.nil?

  # resource path
  local_var_path = '/words/storage/file/move/{srcPath}'[1..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('SrcPath') + '}', self.src_path.nil? ? '' : self.src_path.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('DestPath')] = self.dest_path
  query_params[downcase_first_letter('SrcStorageName')] = self.src_storage_name unless self.src_storage_name.nil?
  query_params[downcase_first_letter('DestStorageName')] = self.dest_storage_name unless self.dest_storage_name.nil?
  query_params[downcase_first_letter('VersionId')] = self.version_id unless self.version_id.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])

  # form parameters
  form_params = []
  files_content = []
  body = api_client.build_request_body(header_params, form_params, files_content)
  {
    'method': :PUT,
    'path': local_var_path,
    'header_params': header_params,
    'query_params': query_params,
    'body': body,
    'auth_names': ['JWT']
  }
end

#downcase_first_letter(str) ⇒ Object

Helper method to convert first letter to downcase



159
160
161
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 159

def downcase_first_letter(str)
  str[0].downcase + str[1..-1]
end

#get_response_type ⇒ Object

Get response type



164
165
166
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 164

def get_response_type
  nil
end

#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


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
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_words_cloud/models/requests/move_file_request.rb', line 64

def to_batch_part(api_client, requestId, parentRequestId = nil)
  # verify the required parameter 'dest_path' is set
  raise ArgumentError, 'Missing the required parameter dest_path when calling WordsApi.move_file' if api_client.config.client_side_validation && self.dest_path.nil?
  # verify the required parameter 'src_path' is set
  raise ArgumentError, 'Missing the required parameter src_path when calling WordsApi.move_file' if api_client.config.client_side_validation && self.src_path.nil?

  # resource path
  local_var_path = '/words/storage/file/move/{srcPath}'[7..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('SrcPath') + '}', self.src_path.nil? ? '' : self.src_path.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('DestPath')] = self.dest_path
  query_params[downcase_first_letter('SrcStorageName')] = self.src_storage_name unless self.src_storage_name.nil?
  query_params[downcase_first_letter('DestStorageName')] = self.dest_storage_name unless self.dest_storage_name.nil?
  query_params[downcase_first_letter('VersionId')] = self.version_id unless self.version_id.nil?

  if query_params
    query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
  end

  header_params = {}
  header_params['RequestId'] = requestId

  if parentRequestId != nil
    header_params['DependsOn'] = parentRequestId
  end

  # form parameters
  form_params = []
  files_content = []

  # http body (model)
  body = api_client.build_request_body_batch(header_params, form_params, files_content)
  part = ""
  part.concat("PUT".force_encoding('UTF-8'))
  part.concat(" ".force_encoding('UTF-8'))
  part.concat(local_var_path.force_encoding('UTF-8'))
  part.concat(" \r\n".force_encoding('UTF-8'))

  header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
  part.concat("\r\n".force_encoding('UTF-8'))
  if body
    if body.is_a?(Hash)
      body.each do |key, value|
        part.concat(value, "\r\n")
      end
    else
      part.concat(body)
    end
  end
 part
end