Class: EmassClient::ArtifactsExportApi

Inherits:
Object
  • Object
show all
Defined in:
lib/emass_client/api/artifacts_export_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArtifactsExportApi

Returns a new instance of ArtifactsExportApi.



19
20
21
 
# File 'lib/emass_client/api/artifacts_export_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/emass_client/api/artifacts_export_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_system_artifacts_export(system_id, filename, opts = {}) ⇒ File

Get the file of an artifact in a system <strong>Sample Responce</strong>
Binary file associated with given filename.
If ‘compress` parameter is specified, zip archive of binary file associated with given filename.

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • filename (String) —

    **File Name**: The file name (to include file-extension).

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

    the optional parameters

Options Hash (opts):

  • :compress (Boolean) —

    **Compress File**: Determines if returned file is compressed. (default to true)

Returns:

  • (File) 


29
30
31
32
 
# File 'lib/emass_client/api/artifacts_export_api.rb', line 29

def get_system_artifacts_export(system_id, filename, opts = {})
  data, _status_code, _headers = get_system_artifacts_export_with_http_info(system_id, filename, opts)
  data
end

#get_system_artifacts_export_with_http_info(system_id, filename, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the file of an artifact in a system &lt;strong&gt;Sample Responce&lt;/strong&gt;&lt;br&gt; Binary file associated with given filename.&lt;br&gt; If &#x60;compress&#x60; parameter is specified, zip archive of binary file associated with given filename.

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • filename (String) —

    **File Name**: The file name (to include file-extension).

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

    the optional parameters

Options Hash (opts):

  • :compress (Boolean) —

    **Compress File**: Determines if returned file is compressed. (default to true)

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



41
42
43
44
45
46
47
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
 
# File 'lib/emass_client/api/artifacts_export_api.rb', line 41

def get_system_artifacts_export_with_http_info(system_id, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArtifactsExportApi.get_system_artifacts_export ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling ArtifactsExportApi.get_system_artifacts_export"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling ArtifactsExportApi.get_system_artifacts_export"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/artifacts-export'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filename'] = filename
  query_params[:'compress'] = opts[:'compress'] if !opts[:'compress'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

  new_options = opts.merge(
    :operation => :"ArtifactsExportApi.get_system_artifacts_export",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArtifactsExportApi#get_system_artifacts_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end