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

Class ApiExternalAccount

source code

         object --+        
                  |        
types.BaseApiObject --+    
                      |    
  types.BaseApiResource --+
                          |
                         ApiExternalAccount
Instance Methods [hide private]
 
__init__(self, resource_root, name=None, displayName=None, typeName=None, accountConfigs=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
 
_path(self)
Returns the path to the resource.		 source code
 
get_config(self, view=None)
Retrieve the external account's configuration.		 source code
 
update_config(self, config)
Update the external account's configuration.		 source code
 
external_account_cmd_by_name(self, command_name)
Executes a command on the external account specified by name.		 source code

Inherited from types.BaseApiResource (private): _api_version, _call, _cmd, _delete, _get, _get_config, _post, _put, _require_min_api_version, _update_config

Inherited from types.BaseApiObject: __setattr__, to_json_dict

Inherited from types.BaseApiObject (private): _check_attr, _get_resource_root, _set_attrs, _update

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 = {'name': None, 'displayName': None, 'typeName': ...

Inherited from types.BaseApiObject (private): _WHITELIST

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, resource_root, name=None, displayName=None, typeName=None, accountConfigs=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)

_path(self)

source code 

Returns the path to the resource.

e.g., for a service 'foo' in cluster 'bar', this should return '/clusters/bar/services/foo'.

Overrides: types.BaseApiResource._path
(inherited documentation)

get_config(self, view=None)

source code 

Retrieve the external account's configuration.

The 'summary' view contains strings as the dictionary values. The full view contains ApiConfig instances as the values.

Parameters:
  • view - View to materialize ('full' or 'summary')
Returns:
Dictionary with configuration data.

update_config(self, config)

source code 

Update the external account's configuration.

Parameters:
  • config - Dictionary with configuration to update.
Returns:
Dictionary with updated configuration.

external_account_cmd_by_name(self, command_name)

source code 

Executes a command on the external account specified by name.

Parameters:
  • command_name - The name of the command.
Returns:
Reference to the submitted command.

Since: API v16


Class Variable Details [hide private]

_ATTRIBUTES

Value:
{'name': None, 'displayName': None, 'typeName': None, 'createdTime': R\
OAttr(), 'lastModifiedTime': ROAttr(), 'accountConfigs': Attr(ApiConfi\
g)}

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Nov 14 03:01:32 2018 http://epydoc.sourceforge.net