Home       Trees       Indices       Help   
Package cm_api :: Package endpoints :: Module parcels
[hide private]
[frames] | no frames]

Module parcels

source code

Classes [hide private]
  ApiParcelState
An object that represents the state of a parcel.
  ApiParcel
An object that represents a parcel and allows administrative operations.
Functions [hide private]
 
get_parcel(resource_root, product, version, cluster_name='default')
Lookup a parcel by name		 source code
 
_get_parcel(resource_root, path) source code
 
get_all_parcels(resource_root, cluster_name='default', view=None)
Get all parcels		 source code
Variables [hide private]
  PARCELS_PATH = '/clusters/%s/parcels'
  PARCEL_PATH = '/clusters/%s/parcels/products/%s/versions/%s'
  __package__ = 'cm_api.endpoints'
Function Details [hide private]

get_parcel(resource_root, product, version, cluster_name='default')

source code 

Lookup a parcel by name

Parameters:
  • resource_root - The root Resource object.
  • product - Parcel product name
  • version - Parcel version
  • cluster_name - Cluster name
Returns:
An ApiService object

get_all_parcels(resource_root, cluster_name='default', view=None)

source code 

Get all parcels

Parameters:
  • resource_root - The root Resource object.
  • cluster_name - Cluster name
Returns:
A list of ApiParcel objects.

Since: API v3


   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Tue Jul 18 02:12:52 2017 http://epydoc.sourceforge.net