Class: VSphereAutomation::Content::LibraryItemDownloadsessionFileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LibraryItemDownloadsessionFileApi

Returns a new instance of LibraryItemDownloadsessionFileApi.



16
17
18
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get(download_session_id, request_body, opts = {}) ⇒ ContentLibraryItemDownloadsessionFileResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsNotFoundError|

Retrieves file download information for a specific file.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 24

def get(download_session_id, request_body, opts = {})
  data, _status_code, _headers = get_with_http_info(download_session_id, request_body, opts)
  data
end

#get_with_http_info(download_session_id, request_body, opts = {}) ⇒ Array<(ContentLibraryItemDownloadsessionFileResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Retrieves file download information for a specific file.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



35
36
37
38
39
40
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
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 35

def get_with_http_info(download_session_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryItemDownloadsessionFileApi.get ...'
  end
  # verify the required parameter 'download_session_id' is set
  if @api_client.config.client_side_validation && download_session_id.nil?
    fail ArgumentError, "Missing the required parameter 'download_session_id' when calling LibraryItemDownloadsessionFileApi.get"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling LibraryItemDownloadsessionFileApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get'.sub('{' + 'download_session_id' + '}', download_session_id.to_s)

  # query parameters
  query_params = {}

  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentLibraryItemDownloadsessionFileResult',
	  '400' => 'Content::VapiStdErrorsInvalidArgumentError',
	  '404' => 'Content::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryItemDownloadsessionFileApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(download_session_id, opts = {}) ⇒ ContentLibraryItemDownloadsessionFileListResult|VapiStdErrorsNotFoundError|

Lists the information of all the files in the library item associated with the download session.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 86

def list(download_session_id, opts = {})
  data, _status_code, _headers = list_with_http_info(download_session_id, opts)
  data
end

#list_with_http_info(download_session_id, opts = {}) ⇒ Array<(ContentLibraryItemDownloadsessionFileListResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Lists the information of all the files in the library item associated with the download session.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 96

def list_with_http_info(download_session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryItemDownloadsessionFileApi.list ...'
  end
  # verify the required parameter 'download_session_id' is set
  if @api_client.config.client_side_validation && download_session_id.nil?
    fail ArgumentError, "Missing the required parameter 'download_session_id' when calling LibraryItemDownloadsessionFileApi.list"
  end
  # resource path
  local_var_path = '/com/vmware/content/library/item/downloadsession/file'

  # query parameters
  query_params = {}
  query_params[:'download_session_id'] = download_session_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentLibraryItemDownloadsessionFileListResult',
	  '404' => 'Content::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryItemDownloadsessionFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#prepare(download_session_id, request_body, opts = {}) ⇒ ContentLibraryItemDownloadsessionFilePrepareResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|

Requests a file to be prepared for download.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



142
143
144
145
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 142

def prepare(download_session_id, request_body, opts = {})
  data, _status_code, _headers = prepare_with_http_info(download_session_id, request_body, opts)
  data
end

#prepare_with_http_info(download_session_id, request_body, opts = {}) ⇒ Array<(ContentLibraryItemDownloadsessionFilePrepareResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Requests a file to be prepared for download.

Parameters:

  • download_session_id —

    Identifier of the download session.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb', line 153

def prepare_with_http_info(download_session_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryItemDownloadsessionFileApi.prepare ...'
  end
  # verify the required parameter 'download_session_id' is set
  if @api_client.config.client_side_validation && download_session_id.nil?
    fail ArgumentError, "Missing the required parameter 'download_session_id' when calling LibraryItemDownloadsessionFileApi.prepare"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling LibraryItemDownloadsessionFileApi.prepare"
  end
  # resource path
  local_var_path = '/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare'.sub('{' + 'download_session_id' + '}', download_session_id.to_s)

  # query parameters
  query_params = {}

  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentLibraryItemDownloadsessionFilePrepareResult',
	  '400' => 'Content::VapiStdErrorsInvalidArgumentError',
	  '403' => 'Content::VapiStdErrorsUnauthorizedError',
	  '404' => 'Content::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryItemDownloadsessionFileApi#prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end