Class: KatelloApi::Resources::SyncPlan

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

def self.doc
  @doc ||= KatelloApi.doc['resources']["sync_plans"]
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):

  • 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



29
30
31
 
# File 'lib/katello_api/resources/sync_plan.rb', line 29

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

    sync plan numeric identifier

  • organization_id (String) —

    filter products by organization name or label

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

  • 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

- (Array) update(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) —

    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



43
44
45
 
# File 'lib/katello_api/resources/sync_plan.rb', line 43

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