Package cm_api :: Package endpoints :: Module services :: Class ApiServiceSetupInfo

[frames] | no frames]

Class ApiServiceSetupInfo

         object --+        
                  |        
types.BaseApiObject --+    
                      |    
             ApiService --+
                          |
                         ApiServiceSetupInfo

Instance Methods

__init__(self, name=None, type=None, config=None, roles=None)
Initializes internal state and sets all known writable properties of the object to None.

source code

set_config(self, config)
Set the service configuration.

source code

add_role_type_info(self, role_type, config)
Add a role type setup info.

source code

add_role_info(self, role_name, role_type, host_id, config=None)
Add a role info.

source code

Inherited from ApiService: __str__, bootstrap_hdfs_stand_by, cancel_impala_query, cleanup_zookeeper, create_beeswax_warehouse, create_hbase_root, create_hdfs_tmp, create_hive_metastore_database, create_hive_metastore_tables, create_hive_warehouse, create_replication_schedule, create_role, create_role_config_group, decommission, delete_replication_schedule, delete_role, delete_role_config_group, deploy_client_config, disable_hdfs_auto_failover, disable_hdfs_ha, disable_jt_ha, enable_hdfs_auto_failover, enable_hdfs_ha, enable_jt_ha, enter_maintenance_mode, exit_maintenance_mode, failover_hdfs, format_hdfs, get_activity, get_all_role_config_groups, get_all_roles, get_commands, get_config, get_impala_queries, get_metrics, get_query_details, get_replication_schedule, get_replication_schedules, get_role, get_role_config_group, get_role_types, get_roles_by_type, get_running_activities, init_hdfs_auto_failover, init_hdfs_shared_dir, init_zookeeper, install_oozie_sharelib, query_activities, recommission, refresh, restart, restart_roles, roll_edits_hdfs, rolling_restart, start, start_roles, stop, stop_roles, sync_hue_db, trigger_replication_schedule, update_config, update_hive_metastore_namenodes, update_replication_schedule, update_role_config_group

Inherited from ApiService (private): _cmd, _get_cluster_name, _parse_svc_config, _path, _role_cmd

Inherited from types.BaseApiObject: __setattr__, to_json_dict

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

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

Class Methods

Inherited from types.BaseApiObject: from_json_dict

Inherited from types.BaseApiObject (private): _get_attributes

Static Methods

Inherited from types.BaseApiObject: init

Class Variables

_ATTRIBUTES = {'name': None, 'type': None, 'config': Attr(ApiC...

Inherited from types.BaseApiObject (private): _WHITELIST

Properties

Inherited from object: __class__

Method Details

init(self, name=None, type=None, config=None, roles=None)
(Constructor)

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)

set_config(self, config)

Set the service configuration.

Parameters:

config - A dictionary of config key/value

add_role_type_info(self, role_type, config)

Add a role type setup info.

Parameters:

role_type - Role type
config - A dictionary of role type configuration

add_role_info(self, role_name, role_type, host_id, config=None)

Add a role info. The role will be created along with the service setup.

Parameters:

role_name - Role name
role_type - Role type
host_id - The host where the role should run
config - (Optional) A dictionary of role config values

Class Variable Details

_ATTRIBUTES

Value:

{'name': None, 'type': None, 'config': Attr(ApiConfig), 'roles': Attr(
roles.ApiRole),}