Class: KatelloApi::Resources::Filter

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/filter.rb

Constant Summary

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

+ (Object) doc 



4
5
6
 
# File 'lib/katello_api/resources/filter.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["filters"]
end

Instance Method Details

- (Array) create(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • content_view_definition_id (String) —

    id of the content view definition

  • filter (Hash) —

    allowed keys are:

    • name [String] name of the filter

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



25
26
27
 
# File 'lib/katello_api/resources/filter.rb', line 25

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) destroy(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    id of the content view definition

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



45
46
47
 
# File 'lib/katello_api/resources/filter.rb', line 45

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) index(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • content_view_definition_id (String) —

    id of the content view definition

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



13
14
15
 
# File 'lib/katello_api/resources/filter.rb', line 13

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) list_products(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    id of the content view definition

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



55
56
57
 
# File 'lib/katello_api/resources/filter.rb', line 55

def list_products(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) list_repositories(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    id of the content view definition

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



76
77
78
 
# File 'lib/katello_api/resources/filter.rb', line 76

def list_repositories(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) show(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    id of the content view definition

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



35
36
37
 
# File 'lib/katello_api/resources/filter.rb', line 35

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) update_products(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    content view definition identifier

  • products (Array) —

    updated list of product ids

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



66
67
68
 
# File 'lib/katello_api/resources/filter.rb', line 66

def update_products(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) update_repositories(params = {}, headers = {})

Returns First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String) —

    name of the filter

  • content_view_definition_id (String) —

    id of the content view definition

  • repos (Array) —

    updated list of repo ids

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



87
88
89
 
# File 'lib/katello_api/resources/filter.rb', line 87

def update_repositories(params = {}, headers = {})
  perform_call(__method__, params, headers)
end