Class: PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_docs_blob_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi

Returns a new instance of PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.



19
20
21
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_docs_blob_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/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_docs_blob_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#read(distro_base_path, name, namespace, path, version, opts = {}) ⇒ CollectionVersionDocsResponse

Returns a CollectionVersion object.

Parameters:

  • distro_base_path (String)
  • name (String)
  • namespace (String)
  • path (String)
  • version (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



32
33
34
35
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_docs_blob_api.rb', line 32

def read(distro_base_path, name, namespace, path, version, opts = {})
  data, _status_code, _headers = read_with_http_info(distro_base_path, name, namespace, path, version, opts)
  data
end

#read_with_http_info(distro_base_path, name, namespace, path, version, opts = {}) ⇒ Array<(CollectionVersionDocsResponse, Integer, Hash)>

Returns a CollectionVersion object.

Parameters:

  • distro_base_path (String)
  • name (String)
  • namespace (String)
  • path (String)
  • version (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_docs_blob_api.rb', line 47

def read_with_http_info(distro_base_path, name, namespace, path, version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read ...'
  end
  # verify the required parameter 'distro_base_path' is set
  if @api_client.config.client_side_validation && distro_base_path.nil?
    fail ArgumentError, "Missing the required parameter 'distro_base_path' when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read"
  end
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.read"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/{version}/docs-blob/'.sub('{' + 'distro_base_path' + '}', CGI.escape(distro_base_path.to_s).gsub('%2F', '/')).sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/')).sub('{' + 'path' + '}', CGI.escape(path.to_s).gsub('%2F', '/')).sub('{' + 'version' + '}', CGI.escape(version.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'CollectionVersionDocsResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  new_options = opts.merge(
    :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: PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end