com.cloudera.api.v14

Interface ExternalAccountsResourceV14

All Known Subinterfaces:

ExternalAccountsResourceV16

public interface ExternalAccountsResourceV14

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

Method Summary

Methods

Modifier and Type	Method and Description
ApiExternalAccount	createAccount(ApiExternalAccount account) Create a new external account.
ApiExternalAccount	deleteAccount(String name) Delete an external account, specifying its name.
ApiExternalAccountCategoryList	getSupportedCategories() List of external account categories supported by this Cloudera Manager.
ApiExternalAccountTypeList	getSupportedTypes(String categoryName) List of external account types supported by this Cloudera Manager by category.
ApiExternalAccount	readAccount(String name, DataView view) Get a single external account by account name.
ApiExternalAccount	readAccountByDisplayName(String displayName, DataView view) Get a single external account by display name.
ApiExternalAccountList	readAccounts(String typeName, DataView view) Get a list of external accounts for a specific account type.
ApiExternalAccount	updateAccount(ApiExternalAccount account) Update an external account.

Method Detail

getSupportedCategories

@Path(value="/supportedCategories")
ApiExternalAccountCategoryList getSupportedCategories()

List of external account categories supported by this Cloudera Manager.

Returns:

external account categories

getSupportedTypes

@Path(value="/supportedTypes/{categoryName}")
ApiExternalAccountTypeList getSupportedTypes(String categoryName)

List of external account types supported by this Cloudera Manager by category.

readAccounts

@Path(value="/type/{typeName}")
ApiExternalAccountList readAccounts(String typeName,
                                       DataView view)

Get a list of external accounts for a specific account type.

readAccount

@Path(value="/account/{name}")
ApiExternalAccount readAccount(String name,
                                  DataView view)

Get a single external account by account name.

readAccountByDisplayName

@Path(value="/accountByDisplayName/{displayName}")
ApiExternalAccount readAccountByDisplayName(String displayName,
                                               DataView view)

Get a single external account by display name.

createAccount

@Path(value="/create")
ApiExternalAccount createAccount(ApiExternalAccount account)

Create a new external account. Account names and display names must be unique, i.e. they must not share names or display names with an existing account. Server generates an account ID for the requested account.

updateAccount

@Path(value="/update")
ApiExternalAccount updateAccount(ApiExternalAccount account)

Update an external account.

deleteAccount

@Path(value="/delete/{name}")
ApiExternalAccount deleteAccount(String name)

Delete an external account, specifying its name.