Class: VSphereAutomation::Content::LibraryItemFileApi
- Inherits:
-
Object
- Object
- VSphereAutomation::Content::LibraryItemFileApi
- Defined in:
- lib/vsphere-automation-content/api/library_item_file_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get(library_item_id, request_body, opts = {}) ⇒ ContentLibraryItemFileResult|VapiStdErrorsNotFoundError|
Retrieves the information for a single file in a library item by its name.
-
#get_with_http_info(library_item_id, request_body, opts = {}) ⇒ Array<(ContentLibraryItemFileResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>
private
Retrieves the information for a single file in a library item by its name.
-
#initialize(api_client = ApiClient.default) ⇒ LibraryItemFileApi
constructor
A new instance of LibraryItemFileApi.
-
#list(library_item_id, opts = {}) ⇒ ContentLibraryItemFileListResult|VapiStdErrorsNotFoundError|
Lists all of the files that are stored within a given library item.
-
#list_with_http_info(library_item_id, opts = {}) ⇒ Array<(ContentLibraryItemFileListResult|VapiStdErrorsNotFoundError|, Fixnum, Hash)>
private
Lists all of the files that are stored within a given library item.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ LibraryItemFileApi
Returns a new instance of LibraryItemFileApi.
16 17 18 |
# File 'lib/vsphere-automation-content/api/library_item_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_file_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#get(library_item_id, request_body, opts = {}) ⇒ ContentLibraryItemFileResult|VapiStdErrorsNotFoundError|
Retrieves the information for a single file in a library item by its name.
24 25 26 27 |
# File 'lib/vsphere-automation-content/api/library_item_file_api.rb', line 24 def get(library_item_id, request_body, opts = {}) data, _status_code, _headers = get_with_http_info(library_item_id, request_body, opts) data end |
#get_with_http_info(library_item_id, request_body, opts = {}) ⇒ Array<(ContentLibraryItemFileResult|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 the information for a single file in a library item by its name.
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 |
# File 'lib/vsphere-automation-content/api/library_item_file_api.rb', line 35 def get_with_http_info(library_item_id, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LibraryItemFileApi.get ...' end # verify the required parameter 'library_item_id' is set if @api_client.config.client_side_validation && library_item_id.nil? fail ArgumentError, "Missing the required parameter 'library_item_id' when calling LibraryItemFileApi.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 LibraryItemFileApi.get" end # resource path local_var_path = '/com/vmware/content/library/item/file/id:{library_item_id}?~action=get'.sub('{' + 'library_item_id' + '}', library_item_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::ContentLibraryItemFileResult', '404' => 'Content::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: LibraryItemFileApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(library_item_id, opts = {}) ⇒ ContentLibraryItemFileListResult|VapiStdErrorsNotFoundError|
Lists all of the files that are stored within a given library item.
85 86 87 88 |
# File 'lib/vsphere-automation-content/api/library_item_file_api.rb', line 85 def list(library_item_id, opts = {}) data, _status_code, _headers = list_with_http_info(library_item_id, opts) data end |
#list_with_http_info(library_item_id, opts = {}) ⇒ Array<(ContentLibraryItemFileListResult|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 all of the files that are stored within a given library item.
95 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 |
# File 'lib/vsphere-automation-content/api/library_item_file_api.rb', line 95 def list_with_http_info(library_item_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LibraryItemFileApi.list ...' end # verify the required parameter 'library_item_id' is set if @api_client.config.client_side_validation && library_item_id.nil? fail ArgumentError, "Missing the required parameter 'library_item_id' when calling LibraryItemFileApi.list" end # resource path local_var_path = '/com/vmware/content/library/item/file' # query parameters query_params = {} query_params[:'library_item_id'] = library_item_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::ContentLibraryItemFileListResult', '404' => 'Content::VapiStdErrorsNotFoundError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: LibraryItemFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |