class PulpcoreClient::RolesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulpcore_client/api/roles_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create(role, opts = {}) click to toggle source

Create a role ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param role [Role] @param [Hash] opts the optional parameters @return [RoleResponse]

# File lib/pulpcore_client/api/roles_api.rb, line 27
def create(role, opts = {})
  data, _status_code, _headers = create_with_http_info(role, opts)
  data
end
create_with_http_info(role, opts = {}) click to toggle source

Create a role ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param role [Role] @param [Hash] opts the optional parameters @return [Array<(RoleResponse, Integer, Hash)>] RoleResponse data, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 37
def create_with_http_info(role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.create ...'
  end
  # verify the required parameter 'role' is set
  if @api_client.config.client_side_validation && role.nil?
    fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/roles/'

  # 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(role) 

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

  # 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: RolesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(role_href, opts = {}) click to toggle source

Delete a role ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param role_href [String] @param [Hash] opts the optional parameters @return [nil]

# File lib/pulpcore_client/api/roles_api.rb, line 91
def delete(role_href, opts = {})
  delete_with_http_info(role_href, opts)
  nil
end
delete_with_http_info(role_href, opts = {}) click to toggle source

Delete a role ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param role_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 101
def delete_with_http_info(role_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.delete ...'
  end
  # verify the required parameter 'role_href' is set
  if @api_client.config.client_side_validation && role_href.nil?
    fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.delete"
  end
  # resource path
  local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_href.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # 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: RolesApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List roles ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param [Hash] opts the optional parameters @option opts [Array<String>] :contains_permission Filter roles that have any of the permissions in the list. @option opts [String] :description Filter results where description matches value @option opts [String] :description__contains Filter results where description contains value @option opts [String] :description__icontains Filter results where description contains value @option opts [String] :description__iexact Filter results where description matches value @option opts [String] :for_object_type Filter roles that only have permissions for the specified object HREF. @option opts [Integer] :limit Number of results to return per page. @option opts [Boolean] :locked Filter results where locked matches value @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @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 [PaginatedRoleResponseList]

# File lib/pulpcore_client/api/roles_api.rb, line 167
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List roles ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param [Hash] opts the optional parameters @option opts [Array<String>] :contains_permission Filter roles that have any of the permissions in the list. @option opts [String] :description Filter results where description matches value @option opts [String] :description__contains Filter results where description contains value @option opts [String] :description__icontains Filter results where description contains value @option opts [String] :description__iexact Filter results where description matches value @option opts [String] :for_object_type Filter roles that only have permissions for the specified object HREF. @option opts [Integer] :limit Number of results to return per page. @option opts [Boolean] :locked Filter results where locked matches value @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @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<(PaginatedRoleResponseList, Integer, Hash)>] PaginatedRoleResponseList data, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 193
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.list ...'
  end
  allowable_values = ["-description", "-locked", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "description", "locked", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated"]
  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/roles/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contains_permission'] = @api_client.build_collection_param(opts[:'contains_permission'], :multi) if !opts[:'contains_permission'].nil?
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'description__contains'] = opts[:'description__contains'] if !opts[:'description__contains'].nil?
  query_params[:'description__icontains'] = opts[:'description__icontains'] if !opts[:'description__icontains'].nil?
  query_params[:'description__iexact'] = opts[:'description__iexact'] if !opts[:'description__iexact'].nil?
  query_params[:'for_object_type'] = opts[:'for_object_type'] if !opts[:'for_object_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'locked'] = opts[:'locked'] if !opts[:'locked'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].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[:'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] || 'PaginatedRoleResponseList' 

  # 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: RolesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
partial_update(role_href, patched_role, opts = {}) click to toggle source

Update a role ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param role_href [String] @param patched_role [PatchedRole] @param [Hash] opts the optional parameters @return [RoleResponse]

# File lib/pulpcore_client/api/roles_api.rb, line 263
def partial_update(role_href, patched_role, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(role_href, patched_role, opts)
  data
end
partial_update_with_http_info(role_href, patched_role, opts = {}) click to toggle source

Update a role ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param role_href [String] @param patched_role [PatchedRole] @param [Hash] opts the optional parameters @return [Array<(RoleResponse, Integer, Hash)>] RoleResponse data, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 274
def partial_update_with_http_info(role_href, patched_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.partial_update ...'
  end
  # verify the required parameter 'role_href' is set
  if @api_client.config.client_side_validation && role_href.nil?
    fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.partial_update"
  end
  # verify the required parameter 'patched_role' is set
  if @api_client.config.client_side_validation && patched_role.nil?
    fail ArgumentError, "Missing the required parameter 'patched_role' when calling RolesApi.partial_update"
  end
  # resource path
  local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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(patched_role) 

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

  # 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: RolesApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(role_href, opts = {}) click to toggle source

Inspect a role ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param role_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 [RoleResponse]

# File lib/pulpcore_client/api/roles_api.rb, line 334
def read(role_href, opts = {})
  data, _status_code, _headers = read_with_http_info(role_href, opts)
  data
end
read_with_http_info(role_href, opts = {}) click to toggle source

Inspect a role ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param role_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<(RoleResponse, Integer, Hash)>] RoleResponse data, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 346
def read_with_http_info(role_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.read ...'
  end
  # verify the required parameter 'role_href' is set
  if @api_client.config.client_side_validation && role_href.nil?
    fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.read"
  end
  # resource path
  local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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] || 'RoleResponse' 

  # 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: RolesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(role_href, role, opts = {}) click to toggle source

Update a role ViewSet for Role. NOTE: This API endpoint is in "tech preview" and subject to change @param role_href [String] @param role [Role] @param [Hash] opts the optional parameters @return [RoleResponse]

# File lib/pulpcore_client/api/roles_api.rb, line 401
def update(role_href, role, opts = {})
  data, _status_code, _headers = update_with_http_info(role_href, role, opts)
  data
end
update_with_http_info(role_href, role, opts = {}) click to toggle source

Update a role ViewSet for Role. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param role_href [String] @param role [Role] @param [Hash] opts the optional parameters @return [Array<(RoleResponse, Integer, Hash)>] RoleResponse data, response status code and response headers

# File lib/pulpcore_client/api/roles_api.rb, line 412
def update_with_http_info(role_href, role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RolesApi.update ...'
  end
  # verify the required parameter 'role_href' is set
  if @api_client.config.client_side_validation && role_href.nil?
    fail ArgumentError, "Missing the required parameter 'role_href' when calling RolesApi.update"
  end
  # verify the required parameter 'role' is set
  if @api_client.config.client_side_validation && role.nil?
    fail ArgumentError, "Missing the required parameter 'role' when calling RolesApi.update"
  end
  # resource path
  local_var_path = '{role_href}'.sub('{' + 'role_href' + '}', CGI.escape(role_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(role) 

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

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