Package cm_api :: Package endpoints :: Module types :: Class ApiConfig
[hide private]
[frames] | no frames]

Class ApiConfig

source code

   object --+    
            |    
BaseApiObject --+
                |
               ApiConfig

Instance Methods [hide private]
 
__init__(self, resource_root, name=None, value=None)
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 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 BaseApiObject: from_json_dict

Inherited from BaseApiObject (private): _get_attributes

Static Methods [hide private]

Inherited from BaseApiObject: init

Class Variables [hide private]
  _ATTRIBUTES = {'name': None, 'value': None, 'required': ROAttr...

Inherited from BaseApiObject (private): _WHITELIST

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, resource_root, name=None, value=None)
(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:
{'name': None, 'value': None, 'required': ROAttr(), 'default': ROAttr(\
), 'displayName': ROAttr(), 'description': ROAttr(), 'relatedName': RO\
Attr(), 'sensitive': ROAttr(), 'validationState': ROAttr(), 'validatio\
nMessage': ROAttr(), 'validationWarningsSuppressed': ROAttr()}