Class: Morpheus::ArchiveFilesInterface

Inherits:
APIClient
  • Object
show all
Defined in:
lib/morpheus/api/archive_files_interface.rb

Constant Summary

Constants inherited from APIClient

Morpheus::APIClient::CLIENT_ID

Instance Attribute Summary

Attributes inherited from APIClient

#client_id

Instance Method Summary collapse

Methods inherited from APIClient

#account_groups, #accounts, #activity, #appliance_settings, #approvals, #apps, #archive_buckets, #archive_files, #auth, #authorization_required?, #backup_jobs, #backup_settings, #backups, #billing, #blueprints, #budgets, #catalog, #catalog_item_types, #certificate_types, #certificates, #cloud_datastores, #cloud_folders, #cloud_policies, #cloud_resource_pools, #clouds, #clusters, #common_interface_options, #containers, #cypher, #dashboard, #datastores, #default_content_type, #default_timeout, #deploy, #deployments, #doc, #dry, #dry_run, #environments, #execute, #execute_schedules, #execution_request, #file_copy_request, #forgot, #group_policies, #groups, #guidance, #health, #image_builder, #initialize, #inspect, #instance_types, #instances, #integration_types, #integrations, #invoice_line_items, #invoices, #jobs, #key_pairs, #library_cluster_layouts, #library_container_scripts, #library_container_templates, #library_container_types, #library_container_upgrades, #library_instance_types, #library_layouts, #library_spec_template_types, #library_spec_templates, #license, #load_balancer_pools, #load_balancer_types, #load_balancer_virtual_servers, #load_balancers, #log_settings, #logged_in?, #login, #logout, #logs, #monitoring, #network_domain_records, #network_domains, #network_groups, #network_pool_ips, #network_pool_servers, #network_pools, #network_proxies, #network_routers, #network_security_servers, #network_services, #network_types, #networks, #old_cypher, #option_type_lists, #option_types, #options, #packages, #ping, #policies, #power_schedules, #price_sets, #prices, #processes, #projects, #provision_types, #provisioning_license_types, #provisioning_licenses, #provisioning_settings, #reports, #roles, #search, #security_group_rules, #security_groups, #server_types, #servers, #service_plans, #set_ssl_verification_enabled, #setopts, #setup, #ssl_verification_enabled?, #storage_providers, #subnet_types, #subnets, #task_sets, #tasks, #to_s, #url, #usage, #use_refresh_token, #user_groups, #user_settings, #user_sources, #users, #vdi, #vdi_allocations, #vdi_apps, #vdi_gateways, #vdi_pools, #virtual_images, #whitelabel_settings, #whoami, #wiki, #withopts

Constructor Details

This class inherits a constructor from Morpheus::APIClient

Instance Method Details



125
126
127
128
129
130
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 125

def create_file_link(file_id, params={})
  url = "#{@base_url}/api/archives/files/#{file_id}/links"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :post, url: url, headers: headers}
  execute(opts)
end

#destroy(id, params = {}) ⇒ Object

def update(id, payload)

url = "#{@base_url}/api/archives/files/#{id}"
headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
execute(opts)

end



166
167
168
169
170
171
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 166

def destroy(id, params={})
  url = "#{@base_url}/api/archives/files/#{id}"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :delete, url: url, headers: headers}
  execute(opts)
end

#destroy_file_link(file_id, link_id, params = {}) ⇒ Object 



135
136
137
138
139
140
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 135

def destroy_file_link(file_id, link_id, params={})
  url = "#{@base_url}/api/archives/files/#{file_id}/links/#{link_id}"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :delete, url: url, headers: headers}
  execute(opts)
end

#download_file_by_link_chunked(link_key, outfile, params = {}) ⇒ Object 



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
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 79

def download_file_by_link_chunked(link_key, outfile, params={})
  raise "#{self.class}.download_file_by_link_chunked() passed a blank file path!" if full_file_path.to_s == ''
  url = "#{@base_url}/public-archives/link"
  params['s'] = link_key
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers, timeout: 172800}
  # execute(opts, {parse_json: false})
  if Dir.exists?(outfile)
    raise "outfile is invalid. It is the name of an existing directory: #{outfile}"
  end
  # if @verify_ssl == false
  #   opts[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
  # end
  if @dry_run
    return opts
  end
  http_response = nil
  File.open(outfile, 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  return http_response
end

#download_file_by_path(full_file_path, params = {}) ⇒ Object

full_file_path is $bucketName/$filePath



13
14
15
16
17
18
19
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 13

def download_file_by_path(full_file_path, params={})
  raise "#{self.class}.download_file_by_path() passed a blank file path!" if full_file_path.to_s == ''
  url = "#{@base_url}/api/archives/download" + "/#{full_file_path}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers, timeout: 172800}
  execute(opts, {parse_json: false})
end

#download_file_by_path_chunked(full_file_path, outfile, params = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 21

def download_file_by_path_chunked(full_file_path, outfile, params={})
  raise "#{self.class}.download_file_by_path_chunked() passed a blank file path!" if full_file_path.to_s == ''
  url = "#{@base_url}/api/archives/download" + "/#{full_file_path}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers, timeout: 172800}
  # execute(opts, {parse_json: false})
  if Dir.exists?(outfile)
    raise "outfile is invalid. It is the name of an existing directory: #{outfile}"
  end
  # if @verify_ssl == false
  #   opts[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
  # end
  if @dry_run
    return opts
  end
  http_response = nil
  File.open(outfile, 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  return http_response
end

#download_file_link(link_key, params = {}) ⇒ Object 



132
133
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 132

def download_file_link(link_key, params={})
end

#download_public_file_by_path_chunked(full_file_path, outfile, params = {}) ⇒ Object 



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
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 50

def download_public_file_by_path_chunked(full_file_path, outfile, params={})
  raise "#{self.class}.download_public_file_by_path_chunked() passed a blank file path!" if full_file_path.to_s == ''
  url = "#{@base_url}/public-archives/download" + "/#{full_file_path}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers, timeout: 172800}
  # execute(opts, {parse_json: false})
  if Dir.exists?(outfile)
    raise "outfile is invalid. It is the name of an existing directory: #{outfile}"
  end
  # if @verify_ssl == false
  #   opts[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
  # end
  if @dry_run
    return opts
  end
  http_response = nil
  File.open(outfile, 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  return http_response
end

#get(file_id, params = {}) ⇒ Object 



4
5
6
7
8
9
10
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 4

def get(file_id, params={})
  raise "#{self.class}.get() passed a blank id!" if file_id.to_s == ''
  url = "#{@base_url}/api/archives/files/#{file_id}"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#history(file_id, params = {}) ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 109

def history(file_id, params={})
  raise "#{self.class}.history() passed a blank id!" if file_id.to_s == ''
  url = "#{@base_url}/api/archives/files/#{file_id}/history"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#list_links(file_id, params = {}) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/morpheus/api/archive_files_interface.rb', line 117

def list_links(file_id, params={})
  raise "#{self.class}.links() passed a blank id!" if file_id.to_s == ''
  url = "#{@base_url}/api/archives/files/#{file_id}/links"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end