Class: KatelloApi::Resources::Sync

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/sync.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

.docObject



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

def self.doc
  @doc ||= KatelloApi.doc['resources']["sync"]
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 /apiorganizations/:organization_id/products/:product_id/sync path

  • product_id (Object)

    Part of /apiorganizations/:organization_id/products/:product_id/sync path

  • provider_id (Object)

    Part of /api/providers/:provider_id/sync path

  • repository_id (Object)

    Part of /api/repositories/:repository_id/sync path

Returns:

  • (Array)

    First item: parsed data; second item: raw body



28
29
30
# File 'lib/katello_api/resources/sync.rb', line 28

def create(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/products/:product_id/sync path

  • product_id (Object)

    Part of /api/organizations/:organization_id/products/:product_id/sync path

  • provider_id (Object)

    Part of /api/providers/:provider_id/sync path

  • repository_id (Object)

    Part of /api/repositories/:repository_id/sync path

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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