com.cloudera.api.v16
Interface ExternalAccountsResourceV16

All Superinterfaces:

ExternalAccountsResourceV14

public interface ExternalAccountsResourceV16
extends ExternalAccountsResourceV14

Manage external accounts used by various Cloudera Manager features, for performing external tasks.

Method Summary

ApiCommand	externalAccountCommandByName(String name, String commandName) Executes a command on the external account specified by name.
ApiCommandMetadataList	listExternalAccountCommands(String typeName) Lists all the commands that can be executed by name on the provided external account type.
ApiConfigList	readConfig(String name, DataView view) Get configs of external account for the given account name.
ApiConfigList	updateConfig(String name, ApiConfigList config, String message) Upadate configs of external account for the given account name.

Methods inherited from interface com.cloudera.api.v14.ExternalAccountsResourceV14

createAccount, deleteAccount, getSupportedCategories, getSupportedTypes, readAccount, readAccountByDisplayName, readAccounts, updateAccount

Method Detail

readConfig

@Path(value="/account/{name}/config")
ApiConfigList readConfig(String name,
                              DataView view)

Get configs of external account for the given account name.

Parameters:

external - account name

view - The view to materialize, either "summary" or "full".

Returns:

the current external account configurations.

updateConfig

@Path(value="/account/{name}/config")
ApiConfigList updateConfig(String name,
                                ApiConfigList config,
                                String message)

Upadate configs of external account for the given account name.

Parameters:

external - account name

config - Settings to update.

message - Optional message describing the changes.

Returns:

The updated configuration.

externalAccountCommandByName

@Path(value="/account/{name}/commands/{commandName}")
ApiCommand externalAccountCommandByName(String name,
                                             String commandName)

Executes a command on the external account specified by name.

Available since API v16.

Parameters:

name - The external account name.

commandName - The command name.

Returns:

Information about the submitted command.

listExternalAccountCommands

@Path(value="/typeInfo/{typeName}/commandsByName")
ApiCommandMetadataList listExternalAccountCommands(String typeName)

Lists all the commands that can be executed by name on the provided external account type.

Available since API v16.

Parameters:

typeName - The external account type name

Returns:

a list of command metadata objects