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

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

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

  • sync_plan (Hash) —

    allowed keys are:

    • description [String, nil] sync plan description

    • interval [String, nil] how often synchronization should run

    • name [String] sync plan name

    • sync_date [String, nil] start datetime of synchronization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

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

  • 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

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

    sync plan numeric identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

  • sync_plan (Hash) —

    allowed keys are:

    • description [String, nil] sync plan description

    • interval [String, nil] how often synchronization should run

    • name [String] sync plan name

    • sync_date [String, nil] start datetime of synchronization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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