class PulpAnsibleClient::RemotesCollectionApi
Attributes
Public Class Methods
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a collection remote ViewSet for Collection Remotes. @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [AnsibleCollectionRemote]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 27 def create(data, opts = {}) data, _status_code, _headers = create_with_http_info(data, opts) data end
Create a collection remote ViewSet for Collection Remotes. @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [Array<(AnsibleCollectionRemote, Integer, Hash)>] AnsibleCollectionRemote data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 37 def create_with_http_info(data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.create ...' end # verify the required parameter 'data' is set if @api_client.config.client_side_validation && data.nil? fail ArgumentError, "Missing the required parameter 'data' when calling RemotesCollectionApi.create" end # resource path local_var_path = '/pulp/api/v3/remotes/ansible/collection/' # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(data) # return_type return_type = opts[:return_type] || 'AnsibleCollectionRemote' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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: RemotesCollectionApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a collection remote Trigger an asynchronous delete task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 91 def delete(collection_remote_href, opts = {}) data, _status_code, _headers = delete_with_http_info(collection_remote_href, opts) data end
Delete a collection remote Trigger an asynchronous delete task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 101 def delete_with_http_info(collection_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.delete ...' end # verify the required parameter 'collection_remote_href' is set if @api_client.config.client_side_validation && collection_remote_href.nil? fail ArgumentError, "Missing the required parameter 'collection_remote_href' when calling RemotesCollectionApi.delete" end # resource path local_var_path = '{collection_remote_href}'.sub('{' + 'collection_remote_href' + '}', CGI.escape(collection_remote_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesCollectionApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List collection remotes ViewSet for Collection Remotes. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :name @option opts [String] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [String] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [String] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [String] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [String] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @option opts [String] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [InlineResponse2006]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 165 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List collection remotes ViewSet for Collection Remotes. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :name @option opts [String] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [String] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [String] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [String] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [String] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @option opts [String] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 187 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.list ...' end # resource path local_var_path = '/pulp/api/v3/remotes/ansible/collection/' # query parameters query_params = opts[:query_params] || {} query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil? query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil? query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil? query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil? query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__range'].nil? query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'InlineResponse2006' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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: RemotesCollectionApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Partially update a collection remote Trigger an asynchronous partial update task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 249 def partial_update(collection_remote_href, data, opts = {}) data, _status_code, _headers = partial_update_with_http_info(collection_remote_href, data, opts) data end
Partially update a collection remote Trigger an asynchronous partial update task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 260 def partial_update_with_http_info(collection_remote_href, data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.partial_update ...' end # verify the required parameter 'collection_remote_href' is set if @api_client.config.client_side_validation && collection_remote_href.nil? fail ArgumentError, "Missing the required parameter 'collection_remote_href' when calling RemotesCollectionApi.partial_update" end # verify the required parameter 'data' is set if @api_client.config.client_side_validation && data.nil? fail ArgumentError, "Missing the required parameter 'data' when calling RemotesCollectionApi.partial_update" end # resource path local_var_path = '{collection_remote_href}'.sub('{' + 'collection_remote_href' + '}', CGI.escape(collection_remote_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(data) # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesCollectionApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a collection remote ViewSet for Collection Remotes. @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [AnsibleCollectionRemote]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 320 def read(collection_remote_href, opts = {}) data, _status_code, _headers = read_with_http_info(collection_remote_href, opts) data end
Inspect a collection remote ViewSet for Collection Remotes. @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(AnsibleCollectionRemote, Integer, Hash)>] AnsibleCollectionRemote data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 332 def read_with_http_info(collection_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.read ...' end # verify the required parameter 'collection_remote_href' is set if @api_client.config.client_side_validation && collection_remote_href.nil? fail ArgumentError, "Missing the required parameter 'collection_remote_href' when calling RemotesCollectionApi.read" end # resource path local_var_path = '{collection_remote_href}'.sub('{' + 'collection_remote_href' + '}', CGI.escape(collection_remote_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} 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] || 'AnsibleCollectionRemote' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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: RemotesCollectionApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a collection remote Trigger an asynchronous update task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 387 def update(collection_remote_href, data, opts = {}) data, _status_code, _headers = update_with_http_info(collection_remote_href, data, opts) data end
Update a collection remote Trigger an asynchronous update task @param collection_remote_href [String] URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ @param data [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 398 def update_with_http_info(collection_remote_href, data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.update ...' end # verify the required parameter 'collection_remote_href' is set if @api_client.config.client_side_validation && collection_remote_href.nil? fail ArgumentError, "Missing the required parameter 'collection_remote_href' when calling RemotesCollectionApi.update" end # verify the required parameter 'data' is set if @api_client.config.client_side_validation && data.nil? fail ArgumentError, "Missing the required parameter 'data' when calling RemotesCollectionApi.update" end # resource path local_var_path = '{collection_remote_href}'.sub('{' + 'collection_remote_href' + '}', CGI.escape(collection_remote_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(data) # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # auth_names auth_names = opts[:auth_names] || ['Basic'] 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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesCollectionApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end