Package pulp :: Package server :: Package api :: Module consumer_group :: Class ConsumerGroupApi

Class ConsumerGroupApi

  object --+    
           |    
base.BaseApi --+
               |
              ConsumerGroupApi

Instance Methods

[hide private]

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

_getcollection(self)

source code

create(self, id, description, consumerids=())
Create a new ConsumerGroup object and return it

source code

consumergroups(self)
List all consumergroups.

source code

consumergroup(self, id)
Return a single ConsumerGroup object

source code

consumers(self, id)
Return consumer ids belonging to this ConsumerGroup

source code

add_consumer(self, groupid, consumerid)
Adds the passed in consumer to this group

source code

_add_consumer(self, consumergroup, consumer)
Responsible for properly associating a Consumer to a ConsumerGroup

source code

delete_consumer(self, groupid, consumerid)

source code

bind(self, id, repoid)
Bind (subscribe) a consumer group to a repo.

source code

unbind(self, id, repoid)
Unbind (unsubscribe) a consumer group from a repo.

source code

installpackages(self, id, packagenames=[])
Install packages on the consumers in a consumer group.

source code

installerrata(self, id, errataids=[], types=[])
Install errata on a consumer group.

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Inherited from base.BaseApi

_indexes(self)

source code

_unique_indexes(self)

source code

clean(self)
Delete all the Objects in the database.

source code

delete(self, **kwargs)
Delete a single stored Object

source code

insert(self, object, check_keys=False)
Insert the object document to the database

source code

update(self, object)
Write the object document to the database

source code

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

_getcollection(self)

source code

Overrides: base.BaseApi._getcollection

create(self, id, description, consumerids=())

source code

Create a new ConsumerGroup object and return it

Decorators:

@audit(params= ['id', 'consumerids'])

add_consumer(self, groupid, consumerid)

source code

Adds the passed in consumer to this group

Decorators:

@audit()

delete_consumer(self, groupid, consumerid)

source code

Decorators:

@audit()

bind(self, id, repoid)

source code

Bind (subscribe) a consumer group to a repo.

Parameters:

id (str) - A consumer group id.
repoid (str) - A repo id to bind.

Decorators:

@audit()

Raises:

PulpException - When consumer group is not found.

unbind(self, id, repoid)

source code

Unbind (unsubscribe) a consumer group from a repo.

Parameters:

id (str) - A consumer group id.
repoid (str) - A repo id to unbind.

Decorators:

@audit()

Raises:

PulpException - When consumer group not found.

installpackages(self, id, packagenames=[])

source code

Install packages on the consumers in a consumer group.

Parameters:

id (str) - A consumer group id.
packagenames ([str,..]) - The package names to install.

Decorators:

@audit()

installerrata(self, id, errataids=[], types=[])

source code

Install errata on a consumer group.

Parameters:

id (str) - A consumergroup id.
errataids ([str,..]) - The errata ids to install.
types (str) - Errata type filter

Class ConsumerGroupApi

__init__(self) (Constructor)

_getcollection(self)

create(self, id, description, consumerids=())

add_consumer(self, groupid, consumerid)

delete_consumer(self, groupid, consumerid)

bind(self, id, repoid)

unbind(self, id, repoid)

installpackages(self, id, packagenames=[])

installerrata(self, id, errataids=[], types=[])

init(self)
(Constructor)