Class: PulpAnsibleClient::ApiCollectionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiCollectionsApi

Returns a new instance of ApiCollectionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get(ansible_collection_href, opts = {}) ⇒ PaginatedGalaxyCollectionResponseList

View for Collection models.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



29
30
31
32
 
# File 'lib/pulp_ansible_client/api/api_collections_api.rb', line 29

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

#get_with_http_info(ansible_collection_href, opts = {}) ⇒ Array<(PaginatedGalaxyCollectionResponseList, Integer, Hash)>

View for Collection models.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
 
# File 'lib/pulp_ansible_client/api/api_collections_api.rb', line 41

def get_with_http_info(ansible_collection_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiCollectionsApi.get ...'
  end
  # verify the required parameter 'ansible_collection_href' is set
  if @api_client.config.client_side_validation && ansible_collection_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling ApiCollectionsApi.get"
  end
  # resource path
  local_var_path = '{ansible_collection_href}api/v2/collections/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'PaginatedGalaxyCollectionResponseList' 

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

  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: ApiCollectionsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(ansible_collection_href, galaxy_collection, opts = {}) ⇒ GalaxyCollectionResponse

Queues a task that creates a new Collection from an uploaded artifact.

Parameters:

  • ansible_collection_href (String)
  • galaxy_collection (GalaxyCollection)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/pulp_ansible_client/api/api_collections_api.rb', line 96

def post(ansible_collection_href, galaxy_collection, opts = {})
  data, _status_code, _headers = post_with_http_info(ansible_collection_href, galaxy_collection, opts)
  data
end

#post_with_http_info(ansible_collection_href, galaxy_collection, opts = {}) ⇒ Array<(GalaxyCollectionResponse, Integer, Hash)>

Queues a task that creates a new Collection from an uploaded artifact.

Parameters:

  • ansible_collection_href (String)
  • galaxy_collection (GalaxyCollection)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    GalaxyCollectionResponse data, response status code and response headers



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/pulp_ansible_client/api/api_collections_api.rb', line 106

def post_with_http_info(ansible_collection_href, galaxy_collection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiCollectionsApi.post ...'
  end
  # verify the required parameter 'ansible_collection_href' is set
  if @api_client.config.client_side_validation && ansible_collection_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_href' when calling ApiCollectionsApi.post"
  end
  # verify the required parameter 'galaxy_collection' is set
  if @api_client.config.client_side_validation && galaxy_collection.nil?
    fail ArgumentError, "Missing the required parameter 'galaxy_collection' when calling ApiCollectionsApi.post"
  end
  # resource path
  local_var_path = '{ansible_collection_href}api/v2/collections/'.sub('{' + 'ansible_collection_href' + '}', CGI.escape(ansible_collection_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[: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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(galaxy_collection) 

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

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

  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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApiCollectionsApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end