Package cm_api :: Package endpoints :: Module services
[hide private]
[frames] | no frames]

Module services

source code

Classes [hide private]
  ApiService
  ApiServiceSetupInfo
Functions [hide private]
 
create_service(resource_root, name, service_type, cluster_name='default')
Create a service
source code
 
get_service(resource_root, name, cluster_name='default')
Lookup a service by name
source code
 
_get_service(resource_root, path) source code
 
get_all_services(resource_root, cluster_name='default', view=None)
Get all services
source code
 
delete_service(resource_root, name, cluster_name='default')
Delete a service by name
source code
Variables [hide private]
  SERVICES_PATH = '/clusters/%s/services'
  SERVICE_PATH = '/clusters/%s/services/%s'
  ROLETYPES_CFG_KEY = 'roleTypeConfigs'
  __package__ = 'cm_api.endpoints'
Function Details [hide private]

create_service(resource_root, name, service_type, cluster_name='default')

source code 

Create a service

Parameters:
  • resource_root - The root Resource object.
  • name - Service name
  • service_type - Service type
  • cluster_name - Cluster name
Returns:
An ApiService object

get_service(resource_root, name, cluster_name='default')

source code 

Lookup a service by name

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

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

source code 

Get all services

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

delete_service(resource_root, name, cluster_name='default')

source code 

Delete a service by name

Parameters:
  • resource_root - The root Resource object.
  • name - Service name
  • cluster_name - Cluster name
Returns:
The deleted ApiService object