Package cm_api :: Package endpoints :: Module parcels :: Class ApiParcelState
[hide private]
[frames] | no frames]

Class ApiParcelState

source code

         object --+    
                  |    
types.BaseApiObject --+
                      |
                     ApiParcelState

An object that represents the state of a parcel.

Instance Methods [hide private]
 
__init__(self, resource_root)
Initializes internal state and sets all known writable properties of the object to None.
source code
 
__str__(self)
Default implementation of __str__.
source code

Inherited from types.BaseApiObject: __setattr__, to_json_dict

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __subclasshook__

Class Methods [hide private]

Inherited from types.BaseApiObject: from_json_dict

Inherited from types.BaseApiObject (private): _get_attributes

Static Methods [hide private]

Inherited from types.BaseApiObject: init

Class Variables [hide private]
  _ATTRIBUTES = {'progress': ROAttr(), 'totalProgress': ROAttr()...

Inherited from types.BaseApiObject (private): _WHITELIST

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, resource_root)
(Constructor)

source code 

Initializes internal state and sets all known writable properties of the object to None. Then initializes the properties given in the provided attributes dictionary.

Parameters:
  • resource_root - API resource object.
  • attrs - optional dictionary of attributes to set. This should only contain r/w attributes.
Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

Default implementation of __str__. Uses the type name and the first attribute retrieved from the attribute map to create the string.

Overrides: object.__str__
(inherited documentation)

Class Variable Details [hide private]

_ATTRIBUTES

Value:
{'progress': ROAttr(), 'totalProgress': ROAttr(), 'count': ROAttr(), '\
totalCount': ROAttr(), 'warnings': ROAttr(), 'errors': ROAttr(),}