class PulpContainerClient::RemotesContainerApi
Attributes
Public Class Methods
# File lib/pulp_container_client/api/remotes_container_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a container remote Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the “policy“ field. “on_demand“ and “streamed“ policies can provide significant disk space savings. @param container_container_remote [ContainerContainerRemote] @param [Hash] opts the optional parameters @return [ContainerContainerRemoteResponse]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 27 def create(container_container_remote, opts = {}) data, _status_code, _headers = create_with_http_info(container_container_remote, opts) data end
Create a container remote Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings. @param container_container_remote [ContainerContainerRemote] @param [Hash] opts the optional parameters @return [Array<(ContainerContainerRemoteResponse, Integer, Hash)>] ContainerContainerRemoteResponse data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 37 def create_with_http_info(container_container_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.create ...' end # verify the required parameter 'container_container_remote' is set if @api_client.config.client_side_validation && container_container_remote.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote' when calling RemotesContainerApi.create" end # resource path local_var_path = '/pulp/api/v3/remotes/container/container/' # 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(container_container_remote) # return_type return_type = opts[:return_type] || 'ContainerContainerRemoteResponse' # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesContainerApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a container remote Trigger an asynchronous delete task @param container_container_remote_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 91 def delete(container_container_remote_href, opts = {}) data, _status_code, _headers = delete_with_http_info(container_container_remote_href, opts) data end
Delete a container remote Trigger an asynchronous delete task @param container_container_remote_href [String] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 101 def delete_with_http_info(container_container_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.delete ...' end # verify the required parameter 'container_container_remote_href' is set if @api_client.config.client_side_validation && container_container_remote_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote_href' when calling RemotesContainerApi.delete" end # resource path local_var_path = '{container_container_remote_href}'.sub('{' + 'container_container_remote_href' + '}', CGI.escape(container_container_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] || ['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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesContainerApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List container remotes Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the “policy“ field. “on_demand“ and “streamed“ policies can provide significant disk space savings. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_last_updated pulp_last_updated @option opts [String] :pulp_last_updated__gt pulp_last_updated__gt @option opts [String] :pulp_last_updated__gte pulp_last_updated__gte @option opts [String] :pulp_last_updated__lt pulp_last_updated__lt @option opts [String] :pulp_last_updated__lte pulp_last_updated__lte @option opts [String] :pulp_last_updated__range pulp_last_updated__range @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 [InlineResponse2005]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 165 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List container remotes Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_last_updated pulp_last_updated @option opts [String] :pulp_last_updated__gt pulp_last_updated__gt @option opts [String] :pulp_last_updated__gte pulp_last_updated__gte @option opts [String] :pulp_last_updated__lt pulp_last_updated__lt @option opts [String] :pulp_last_updated__lte pulp_last_updated__lte @option opts [String] :pulp_last_updated__range pulp_last_updated__range @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<(InlineResponse2005, Integer, Hash)>] InlineResponse2005 data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 187 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.list ...' end # resource path local_var_path = '/pulp/api/v3/remotes/container/container/' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].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__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__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__range'].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] || 'InlineResponse2005' # 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: RemotesContainerApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a container remote Trigger an asynchronous partial update task @param container_container_remote_href [String] @param patchedcontainer_container_remote [PatchedcontainerContainerRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 249 def partial_update(container_container_remote_href, patchedcontainer_container_remote, opts = {}) data, _status_code, _headers = partial_update_with_http_info(container_container_remote_href, patchedcontainer_container_remote, opts) data end
Update a container remote Trigger an asynchronous partial update task @param container_container_remote_href [String] @param patchedcontainer_container_remote [PatchedcontainerContainerRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 260 def partial_update_with_http_info(container_container_remote_href, patchedcontainer_container_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.partial_update ...' end # verify the required parameter 'container_container_remote_href' is set if @api_client.config.client_side_validation && container_container_remote_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote_href' when calling RemotesContainerApi.partial_update" end # verify the required parameter 'patchedcontainer_container_remote' is set if @api_client.config.client_side_validation && patchedcontainer_container_remote.nil? fail ArgumentError, "Missing the required parameter 'patchedcontainer_container_remote' when calling RemotesContainerApi.partial_update" end # resource path local_var_path = '{container_container_remote_href}'.sub('{' + 'container_container_remote_href' + '}', CGI.escape(container_container_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', '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(patchedcontainer_container_remote) # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # 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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesContainerApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a container remote Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the “policy“ field. “on_demand“ and “streamed“ policies can provide significant disk space savings. @param container_container_remote_href [String] @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 [ContainerContainerRemoteResponse]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 320 def read(container_container_remote_href, opts = {}) data, _status_code, _headers = read_with_http_info(container_container_remote_href, opts) data end
Inspect a container remote Container remotes represent an external repository that implements the Container Registry API. Container remotes support deferred downloading by configuring the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide significant disk space savings. @param container_container_remote_href [String] @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<(ContainerContainerRemoteResponse, Integer, Hash)>] ContainerContainerRemoteResponse data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 332 def read_with_http_info(container_container_remote_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.read ...' end # verify the required parameter 'container_container_remote_href' is set if @api_client.config.client_side_validation && container_container_remote_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote_href' when calling RemotesContainerApi.read" end # resource path local_var_path = '{container_container_remote_href}'.sub('{' + 'container_container_remote_href' + '}', CGI.escape(container_container_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] || 'ContainerContainerRemoteResponse' # 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: RemotesContainerApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a container remote Trigger an asynchronous update task @param container_container_remote_href [String] @param container_container_remote [ContainerContainerRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/remotes_container_api.rb, line 387 def update(container_container_remote_href, container_container_remote, opts = {}) data, _status_code, _headers = update_with_http_info(container_container_remote_href, container_container_remote, opts) data end
Update a container remote Trigger an asynchronous update task @param container_container_remote_href [String] @param container_container_remote [ContainerContainerRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_container_client/api/remotes_container_api.rb, line 398 def update_with_http_info(container_container_remote_href, container_container_remote, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RemotesContainerApi.update ...' end # verify the required parameter 'container_container_remote_href' is set if @api_client.config.client_side_validation && container_container_remote_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote_href' when calling RemotesContainerApi.update" end # verify the required parameter 'container_container_remote' is set if @api_client.config.client_side_validation && container_container_remote.nil? fail ArgumentError, "Missing the required parameter 'container_container_remote' when calling RemotesContainerApi.update" end # resource path local_var_path = '{container_container_remote_href}'.sub('{' + 'container_container_remote_href' + '}', CGI.escape(container_container_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', '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(container_container_remote) # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # 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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RemotesContainerApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end