Class: KatelloApi::Resources::SyncPlan

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

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

.doc ⇒ Object 



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

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

Instance Method Details

#add_products(params = {}, headers = {}) ⇒ Array

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 sync plan

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/sync_plans/:id/products path

  • product_ids (Array) —

    list of product ids to add to the sync plan

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



94
95
96
 
# File 'lib/katello_api/resources/sync_plan.rb', line 94

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

#available_products(params = {}, headers = {}) ⇒ Array

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

    Part of /api/organizations/:organization_id/sync_plans/:id/available_products path

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/sync_plans/:id/available_products path

  • full_results (String) —

    whether or not to show all results

  • name (String) —

    product name to filter by

  • order (String) —

    sort field and order, eg. ‘name desc’

  • page (String) —

    page number, starting at 1

  • per_page (String) —

    number of results per page to return

  • search (String) —

    search string

  • sort (Hash) —

    hash version of ‘order’ param allowed keys are:

    • by [String] field to sort the results on

    • order [String] how to order the sorted results (e.g. asc for ascending)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



83
84
85
 
# File 'lib/katello_api/resources/sync_plan.rb', line 83

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

#create(params = {}, headers = {}) ⇒ Array

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

  • organization_id (String) —

    filter products by organization name or label

  • description (String) —

    sync plan description

  • interval (String) —

    how often synchronization should run

  • name (String) —

    sync plan name

  • sync_date (String) —

    start datetime of synchronization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/katello_api/resources/sync_plan.rb', line 39

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

#destroy(params = {}, headers = {}) ⇒ Array

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

    sync plan numeric identifier

  • organization_id (String) —

    filter products by organization name or label

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



63
64
65
 
# File 'lib/katello_api/resources/sync_plan.rb', line 63

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

#index(params = {}, headers = {}) ⇒ Array

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

  • organization_id (String) —

    filter products by organization name or label

  • interval (String) —

    filter by interval

  • name (String) —

    filter by name

  • sync_date (String) —

    filter by sync date

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



16
17
18
 
# File 'lib/katello_api/resources/sync_plan.rb', line 16

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

#remove_products(params = {}, headers = {}) ⇒ Array

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 sync plan

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/sync_plans/:id/products path

  • product_ids (Array) —

    list of product ids to remove from the sync plan

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



105
106
107
 
# File 'lib/katello_api/resources/sync_plan.rb', line 105

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

#show(params = {}, headers = {}) ⇒ Array

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

    product numeric identifier

  • organization_id (String) —

    filter products by organization name or label

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



26
27
28
 
# File 'lib/katello_api/resources/sync_plan.rb', line 26

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

#update(params = {}, headers = {}) ⇒ Array

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

    sync plan numeric identifier

  • organization_id (String) —

    filter products by organization name or label

  • description (String) —

    sync plan description

  • interval (String) —

    how often synchronization should run

  • name (String) —

    sync plan name

  • sync_date (String) —

    start datetime of synchronization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



53
54
55
 
# File 'lib/katello_api/resources/sync_plan.rb', line 53

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