pulp_container_client 2.20.3 → 2.21.0

data/lib/pulp_container_client/api/task_schedules_api.rb

@@ -0,0 +1,462 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module PulpContainerClient
+  class TaskSchedulesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Add a role
+    # Add a role for this object to users/groups.
+    # @param task_schedule_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def task_schedules_add_role(task_schedule_href, nested_role, opts = {})
+      data, _status_code, _headers = task_schedules_add_role_with_http_info(task_schedule_href, nested_role, opts)
+      data
+    end
+
+    # Add a role
+    # Add a role for this object to users/groups.
+    # @param task_schedule_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def task_schedules_add_role_with_http_info(task_schedule_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_add_role ...'
+      end
+      # verify the required parameter 'task_schedule_href' is set
+      if @api_client.config.client_side_validation && task_schedule_href.nil?
+        fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.task_schedules_add_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling TaskSchedulesApi.task_schedules_add_role"
+      end
+      # resource path
+      local_var_path = '{task_schedule_href}add_role/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_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(nested_role) 
+
+      # return_type
+      return_type = opts[:return_type] || 'NestedRoleResponse' 
+
+      # 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: TaskSchedulesApi#task_schedules_add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List task schedules
+    # ViewSet to monitor task schedules.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [String] :name Filter results where name matches value
+    # @option opts [String] :name__contains Filter results where name contains value
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;next_dispatch&#x60; - Next dispatch * &#x60;-next_dispatch&#x60; - Next dispatch (descending) * &#x60;dispatch_interval&#x60; - Dispatch interval * &#x60;-dispatch_interval&#x60; - Dispatch interval (descending) * &#x60;task_name&#x60; - Task name * &#x60;-task_name&#x60; - Task name (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
+    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [String] :q 
+    # @option opts [String] :task_name Filter results where task_name matches value
+    # @option opts [String] :task_name__contains Filter results where task_name contains value
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [PaginatedTaskScheduleResponseList]
+    def task_schedules_list(opts = {})
+      data, _status_code, _headers = task_schedules_list_with_http_info(opts)
+      data
+    end
+
+    # List task schedules
+    # ViewSet to monitor task schedules.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [String] :name Filter results where name matches value
+    # @option opts [String] :name__contains Filter results where name contains value
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;next_dispatch&#x60; - Next dispatch * &#x60;-next_dispatch&#x60; - Next dispatch (descending) * &#x60;dispatch_interval&#x60; - Dispatch interval * &#x60;-dispatch_interval&#x60; - Dispatch interval (descending) * &#x60;task_name&#x60; - Task name * &#x60;-task_name&#x60; - Task name (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
+    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [String] :q 
+    # @option opts [String] :task_name Filter results where task_name matches value
+    # @option opts [String] :task_name__contains Filter results where task_name contains value
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(PaginatedTaskScheduleResponseList, Integer, Hash)>] PaginatedTaskScheduleResponseList data, response status code and response headers
+    def task_schedules_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_list ...'
+      end
+      allowable_values = ["-dispatch_interval", "-name", "-next_dispatch", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-task_name", "dispatch_interval", "name", "next_dispatch", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "task_name"]
+      if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/task-schedules/'
+
+      # 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__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
+      query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
+      query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'task_name'] = opts[:'task_name'] if !opts[:'task_name'].nil?
+      query_params[:'task_name__contains'] = opts[:'task_name__contains'] if !opts[:'task_name__contains'].nil?
+      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] || 'PaginatedTaskScheduleResponseList' 
+
+      # 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: TaskSchedulesApi#task_schedules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List roles
+    # List roles assigned to this object.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [ObjectRolesResponse]
+    def task_schedules_list_roles(task_schedule_href, opts = {})
+      data, _status_code, _headers = task_schedules_list_roles_with_http_info(task_schedule_href, opts)
+      data
+    end
+
+    # List roles
+    # List roles assigned to this object.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers
+    def task_schedules_list_roles_with_http_info(task_schedule_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_list_roles ...'
+      end
+      # verify the required parameter 'task_schedule_href' is set
+      if @api_client.config.client_side_validation && task_schedule_href.nil?
+        fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.task_schedules_list_roles"
+      end
+      # resource path
+      local_var_path = '{task_schedule_href}list_roles/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.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] || 'ObjectRolesResponse' 
+
+      # 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: TaskSchedulesApi#task_schedules_list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List user permissions
+    # List permissions available to the current user on this object.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [MyPermissionsResponse]
+    def task_schedules_my_permissions(task_schedule_href, opts = {})
+      data, _status_code, _headers = task_schedules_my_permissions_with_http_info(task_schedule_href, opts)
+      data
+    end
+
+    # List user permissions
+    # List permissions available to the current user on this object.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers
+    def task_schedules_my_permissions_with_http_info(task_schedule_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_my_permissions ...'
+      end
+      # verify the required parameter 'task_schedule_href' is set
+      if @api_client.config.client_side_validation && task_schedule_href.nil?
+        fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.task_schedules_my_permissions"
+      end
+      # resource path
+      local_var_path = '{task_schedule_href}my_permissions/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.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] || 'MyPermissionsResponse' 
+
+      # 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: TaskSchedulesApi#task_schedules_my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect a task schedule
+    # ViewSet to monitor task schedules.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [TaskScheduleResponse]
+    def task_schedules_read(task_schedule_href, opts = {})
+      data, _status_code, _headers = task_schedules_read_with_http_info(task_schedule_href, opts)
+      data
+    end
+
+    # Inspect a task schedule
+    # ViewSet to monitor task schedules.
+    # @param task_schedule_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(TaskScheduleResponse, Integer, Hash)>] TaskScheduleResponse data, response status code and response headers
+    def task_schedules_read_with_http_info(task_schedule_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_read ...'
+      end
+      # verify the required parameter 'task_schedule_href' is set
+      if @api_client.config.client_side_validation && task_schedule_href.nil?
+        fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.task_schedules_read"
+      end
+      # resource path
+      local_var_path = '{task_schedule_href}'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_href.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] || 'TaskScheduleResponse' 
+
+      # 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: TaskSchedulesApi#task_schedules_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove a role
+    # Remove a role for this object from users/groups.
+    # @param task_schedule_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def task_schedules_remove_role(task_schedule_href, nested_role, opts = {})
+      data, _status_code, _headers = task_schedules_remove_role_with_http_info(task_schedule_href, nested_role, opts)
+      data
+    end
+
+    # Remove a role
+    # Remove a role for this object from users/groups.
+    # @param task_schedule_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def task_schedules_remove_role_with_http_info(task_schedule_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.task_schedules_remove_role ...'
+      end
+      # verify the required parameter 'task_schedule_href' is set
+      if @api_client.config.client_side_validation && task_schedule_href.nil?
+        fail ArgumentError, "Missing the required parameter 'task_schedule_href' when calling TaskSchedulesApi.task_schedules_remove_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling TaskSchedulesApi.task_schedules_remove_role"
+      end
+      # resource path
+      local_var_path = '{task_schedule_href}remove_role/'.sub('{' + 'task_schedule_href' + '}', CGI.escape(task_schedule_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(nested_role) 
+
+      # return_type
+      return_type = opts[:return_type] || 'NestedRoleResponse' 
+
+      # 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: TaskSchedulesApi#task_schedules_remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end