com.cloudera.api.v15

Interface ClouderaManagerResourceV15

All Superinterfaces:

ClouderaManagerResource, ClouderaManagerResourceV11, ClouderaManagerResourceV12, ClouderaManagerResourceV14, ClouderaManagerResourceV2, ClouderaManagerResourceV3, ClouderaManagerResourceV6, ClouderaManagerResourceV7, ClouderaManagerResourceV8

All Known Subinterfaces:

ClouderaManagerResourceV16, ClouderaManagerResourceV17, ClouderaManagerResourceV18, ClouderaManagerResourceV19

public interface ClouderaManagerResourceV15
extends ClouderaManagerResourceV14

Method Summary

Methods

Modifier and Type	Method and Description
ApiShutdownReadiness	getShutdownReadiness(String lastActivityTime) Retrieve Cloudera Manager's readiness for shutdown and destroy.
ApiCommand	hostsRecommissionWithStartCommand(ApiHostNameList hostNameList) Recommission the given hosts.
ApiConfigList	updateConfig(ApiConfigList config, String message) Update the Cloudera Manager settings.

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

getScmDbInfo

Methods inherited from interface com.cloudera.api.v12.ClouderaManagerResourceV12

importClusterTemplate

Methods inherited from interface com.cloudera.api.v11.ClouderaManagerResourceV11

getCmPeersResource

Methods inherited from interface com.cloudera.api.v8.ClouderaManagerResourceV8

getMgmtServiceResource

Methods inherited from interface com.cloudera.api.v7.ClouderaManagerResourceV7

getKerberosPrincipals, importAdminCredentials, importKerberosPrincipal

Methods inherited from interface com.cloudera.api.v6.ClouderaManagerResourceV6

beginTrial, endTrial, getLicensedFeatureUsage, hostInstallCommand

Methods inherited from interface com.cloudera.api.v3.ClouderaManagerResourceV3

getAllHostsResource

Methods inherited from interface com.cloudera.api.v2.ClouderaManagerResourceV2

getDeployment, hostsDecommissionCommand, hostsRecommissionCommand, hostsStartRolesCommand, updateDeployment

Methods inherited from interface com.cloudera.api.v1.ClouderaManagerResource

collectDiagnosticDataCommand, generateCredentialsCommand, getConfig, getLog, getVersion, inspectHostsCommand, listActiveCommands, readLicense, updateConfig, updateLicense

Method Detail

updateConfig

@Path(value="/config")
ApiConfigList updateConfig(ApiConfigList config,
                              String message)

Update the Cloudera Manager settings.

If a value is set in the given configuration, it will be added to the manager's settings, replacing any existing entry. If a value is unset (its value is null), the existing the setting will be erased.

Settings that are not listed in the input will maintain their current values.

Parameters:

config - Settings to update.

message - Optional message describing the changes.

Returns:

The updated configuration.

getShutdownReadiness

@Path(value="/shutdownReadiness")
ApiShutdownReadiness getShutdownReadiness(String lastActivityTime)

Retrieve Cloudera Manager's readiness for shutdown and destroy. Applications that wish to destroy Cloudera Manager and its managed cluster should poll this API, repeatedly if necessary, to respect its readiness.

Parameters:

lastActivityTime - End time of the last known activity/workload against the managed clusters, in ISO 8601 format.

Returns:

Cloudera Manager readiness for shutdown

hostsRecommissionWithStartCommand

@Path(value="/commands/hostsRecommissionWithStart")
ApiCommand hostsRecommissionWithStartCommand(ApiHostNameList hostNameList)

Recommission the given hosts. If slave roles support start when decommissioned, start those roles before recommission. All slave roles on the hosts will be recommissioned. Warning: Evolving. This method may change in the future and does not offer standard compatibility guarantees. Recommission the given hosts. If possible, start those roles before recommission. All slave roles on the hosts will be recommissioned. Do not use without guidance from Cloudera. Currently, only HDFS DataNodes will be started by this command.

Returns:

Information about the submitted command.