Class: KatelloApi::Resources::FilterRule

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/filter_rule.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_rule.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["filter_rules"]
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_id (String) —

    name of the filter

  • rule (Hash) —

    allowed keys are:

    • content [String] content type of the rule

    • inclusion [String, nil] true if its an includes rule, false otherwise. defauls to true

    • rule [String] a specification of the rule in json format (required).

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



19
20
21
 
# File 'lib/katello_api/resources/filter_rule.rb', line 19

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) —

    id of the filter rule

  • content_view_definition_id (String) —

    id of the content view definition

  • filter_id (String) —

    name of the filter

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



30
31
32
 
# File 'lib/katello_api/resources/filter_rule.rb', line 30

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