pulp_container_client 1.0.0rc1

data/lib/pulp_container_client/api/remotes_container_api.rb

@@ -0,0 +1,448 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module PulpContainerClient
+  class RemotesContainerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    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 data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [ContainerContainerRemote]
+    def create(data, opts = {})
+      data, _status_code, _headers = create_with_http_info(data, 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 data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ContainerContainerRemote, Integer, Hash)>] ContainerContainerRemote data, response status code and response headers
+    def create_with_http_info(data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RemotesContainerApi.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 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'])
+
+      # 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] || 'ContainerContainerRemote' 
+
+      # 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: 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_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def delete(container_remote_href, opts = {})
+      data, _status_code, _headers = delete_with_http_info(container_remote_href, opts)
+      data
+    end
+
+    # Delete a container remote
+    # Trigger an asynchronous delete task
+    # @param container_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def delete_with_http_info(container_remote_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RemotesContainerApi.delete ...'
+      end
+      # verify the required parameter 'container_remote_href' is set
+      if @api_client.config.client_side_validation && container_remote_href.nil?
+        fail ArgumentError, "Missing the required parameter 'container_remote_href' when calling RemotesContainerApi.delete"
+      end
+      # resource path
+      local_var_path = '{container_remote_href}'.sub('{' + 'container_remote_href' + '}', CGI.escape(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] || ['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: 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 [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 [InlineResponse2004]
+    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 &#x60;&#x60;policy&#x60;&#x60; field.  &#x60;&#x60;on_demand&#x60;&#x60; and &#x60;&#x60;streamed&#x60;&#x60; policies can provide significant disk space savings.
+    # @param [Hash] opts the optional parameters
+    # @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<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
+    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[:'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] || 'InlineResponse2004' 
+
+      # 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: RemotesContainerApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Partially update a container remote
+    # Trigger an asynchronous partial update task
+    # @param container_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def partial_update(container_remote_href, data, opts = {})
+      data, _status_code, _headers = partial_update_with_http_info(container_remote_href, data, opts)
+      data
+    end
+
+    # Partially update a container remote
+    # Trigger an asynchronous partial update task
+    # @param container_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def partial_update_with_http_info(container_remote_href, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RemotesContainerApi.partial_update ...'
+      end
+      # verify the required parameter 'container_remote_href' is set
+      if @api_client.config.client_side_validation && container_remote_href.nil?
+        fail ArgumentError, "Missing the required parameter 'container_remote_href' when calling RemotesContainerApi.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 RemotesContainerApi.partial_update"
+      end
+      # resource path
+      local_var_path = '{container_remote_href}'.sub('{' + 'container_remote_href' + '}', CGI.escape(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'])
+
+      # 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: 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_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/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 [ContainerContainerRemote]
+    def read(container_remote_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(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 &#x60;&#x60;policy&#x60;&#x60; field.  &#x60;&#x60;on_demand&#x60;&#x60; and &#x60;&#x60;streamed&#x60;&#x60; policies can provide significant disk space savings.
+    # @param container_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/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<(ContainerContainerRemote, Integer, Hash)>] ContainerContainerRemote data, response status code and response headers
+    def read_with_http_info(container_remote_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RemotesContainerApi.read ...'
+      end
+      # verify the required parameter 'container_remote_href' is set
+      if @api_client.config.client_side_validation && container_remote_href.nil?
+        fail ArgumentError, "Missing the required parameter 'container_remote_href' when calling RemotesContainerApi.read"
+      end
+      # resource path
+      local_var_path = '{container_remote_href}'.sub('{' + 'container_remote_href' + '}', CGI.escape(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] || 'ContainerContainerRemote' 
+
+      # 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: 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_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def update(container_remote_href, data, opts = {})
+      data, _status_code, _headers = update_with_http_info(container_remote_href, data, opts)
+      data
+    end
+
+    # Update a container remote
+    # Trigger an asynchronous update task
+    # @param container_remote_href [String] URI of Container Remote. e.g.: /pulp/api/v3/remotes/container/container/1/
+    # @param data [ContainerContainerRemote] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def update_with_http_info(container_remote_href, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RemotesContainerApi.update ...'
+      end
+      # verify the required parameter 'container_remote_href' is set
+      if @api_client.config.client_side_validation && container_remote_href.nil?
+        fail ArgumentError, "Missing the required parameter 'container_remote_href' when calling RemotesContainerApi.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 RemotesContainerApi.update"
+      end
+      # resource path
+      local_var_path = '{container_remote_href}'.sub('{' + 'container_remote_href' + '}', CGI.escape(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'])
+
+      # 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: RemotesContainerApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end