Uses of Package
com.cloudera.api.model

Packages that use com.cloudera.api.model

Package	Description
com.cloudera.api.model	Java models of the underlying API JSON objects, with JAX-B annotations.
com.cloudera.api.v1	API version 1, introduced in Cloudera Manager 4.0.
com.cloudera.api.v10	API version 10, introduced in Cloudera Manager 5.4.0.
com.cloudera.api.v11	API version 11, introduced in Cloudera Manager 5.5.0.
com.cloudera.api.v12	API version 12, introduced in Cloudera Manager 5.7.0.
com.cloudera.api.v13	API version 13, introduced in Cloudera Manager 5.8.0.
com.cloudera.api.v14	API version 14, introduced in Cloudera Manager 5.9.0.
com.cloudera.api.v15	API version 15, introduced in Cloudera Manager 5.10.0.
com.cloudera.api.v16	API version 16, introduced in Cloudera Manager 5.11.0.
com.cloudera.api.v17	API version 17, introduced in Cloudera Manager 5.12.0.
com.cloudera.api.v2	API version 2, introduced in Cloudera Manager 4.1.
com.cloudera.api.v3	API version 3, introduced in Cloudera Manager 4.5.
com.cloudera.api.v4	API version 4, introduced in Cloudera Manager 4.6.
com.cloudera.api.v5	API version 5, introduced in Cloudera Manager 4.7.
com.cloudera.api.v6	API version 6, introduced in Cloudera Manager 5.0.0-beta-1.
com.cloudera.api.v7	API version 7, introduced in Cloudera Manager 5.1.0.
com.cloudera.api.v8	API version 8, introduced in Cloudera Manager 5.2.0.
com.cloudera.api.v9	API version 9, introduced in Cloudera Manager 5.3.0.

Classes in com.cloudera.api.model used by com.cloudera.api.model

Class and Description
ApiActivity Represents a user activity, such as a MapReduce job, a Hive query, an Oozie workflow, etc.
ApiActivityStatus
ApiActivityType
ApiAudit Models audit events from both CM and CM managed services like HDFS, HBase and Hive.
ApiBatchRequestElement A single element of a batch request, often part of a list with other elements.
ApiBatchRequestElement.HTTPMethod
ApiBatchResponseElement A single element of a batch response, often part of a list with other elements.
ApiCluster A cluster represents a set of interdependent services running on a set of hosts.
ApiClusterRef A clusterRef references a cluster.
ApiClusterTemplateConfig Config Details: The config can either have a value or ref or variable.
ApiClusterTemplateHostInfo This contains information about the host or host range on which provided host template will be applied.
ApiClusterTemplateHostTemplate Host templates will contain information about the role config groups that should be applied to a host.
ApiClusterTemplateInstantiator Details of cluster template
ApiClusterTemplateRole Role info: This will contain information related to a role referred by some configuration.
ApiClusterTemplateRoleConfigGroup Role config group info.
ApiClusterTemplateRoleConfigGroupInfo During import time information related to all the non-base config groups must be provided.
ApiClusterTemplateService Service information
ApiClusterTemplateVariable Variable that is referred in cluster template.
ApiClusterVersion The CDH version of the cluster.
ApiCmPeer Information about a Cloudera Manager peer instance.
ApiCmPeerType Enum for CM peer types.
ApiCommand Provides detailed information about a submitted command.
ApiCommandList A list of commands.
ApiCommandMetadata Provides metadata information about a command.
ApiCommissionState Represents the Commission state of an entity.
ApiConfig Model for a configuration parameter.
ApiConfig.ValidationState
ApiConfigList A list of configuration data.
ApiConfigStalenessStatus Represents the configuration staleness status of an entity.
ApiDashboard A dashboard definition.
ApiEntityStatus The single value used by the Cloudera Manager UI to represent the status of the entity.
ApiEntityType Represents the types of entities.
ApiEvent Events model noteworthy incidents in Cloudera Manager or the managed Hadoop cluster.
ApiEventAttribute
ApiEventCategory
ApiEventQueryResult
ApiEventSeverity
ApiExternalAccount Represents an instantiation of an external account type, referencing a supported external account type, via the typeName field, along with suitable configuration to access an external resource of the provided type.
ApiExternalAccountCategory Type representing an external account category.
ApiExternalAccountType A supported external account type.
ApiHBaseSnapshot An HBase snapshot descriptor.
ApiHBaseSnapshot.Storage
ApiHBaseSnapshotError A HBase snapshot operation error.
ApiHBaseSnapshotPolicyArguments HBase specific snapshot policy arguments.
ApiHBaseSnapshotResult Detailed information about an HBase snapshot command.
ApiHdfsCloudReplicationArguments
ApiHdfsReplicationArguments Replication arguments for HDFS.
ApiHdfsReplicationArguments.ReplicationStrategy The strategy for distributing the file replication tasks among the mappers of the MR job associated with a replication.
ApiHdfsReplicationCounter A counter in an HDFS replication job.
ApiHdfsReplicationResult Detailed information about an HDFS replication job.
ApiHdfsSnapshot An HDFS snapshot descriptor.
ApiHdfsSnapshotError An HDFS snapshot operation error.
ApiHdfsSnapshotPolicyArguments HDFS specific snapshot policy arguments.
ApiHdfsSnapshotResult Detailed information about an HDFS snapshot command.
ApiHdfsUsageReportRow
ApiHealthCheck Represents a result from a health test performed by Cloudera Manager for an entity.
ApiHealthSummary Represents of the high-level health status of a subject in the cluster.
ApiHiveCloudReplicationArguments
ApiHiveCloudReplicationArguments.ReplicationOption This will decide how cloud replication will take place
ApiHiveReplicationArguments Replication arguments for Hive services.
ApiHiveReplicationError A Hive replication error.
ApiHiveReplicationResult Detailed information about a Hive replication job.
ApiHiveTable A Hive table identifier.
ApiHiveUDF An hive UDF identifier.
ApiHost This is the model for a host in the system.
ApiHostRef A reference to a host.
ApiHostTemplate A host template belongs to a cluster and contains a set of role config groups for slave roles (such as DataNodes and TaskTrackers) from services in the cluster.
ApiHostTemplateList A list of host templates.
ApiImpalaQuery Represents an Impala Query.
ApiImpalaQueryAttribute Metadata about an Impala query attribute.
ApiImpalaUDF An impala UDF identifier.
ApiJournalNodeArguments Arguments used as part of ApiEnableNnHaArguments to specify JournalNodes.
ApiMetric A metric represents a specific metric monitored by the Cloudera Management Services, and a list of values matching a user query.
ApiMetricData A single data point of metric data.
ApiMetricSchema A metric schema represents the schema for a specific metric monitored by the Cloudera Management Services.
ApiMr2AppInformation Represents MapReduce2 information for a YARN application.
ApiMrUsageReportRow
ApiNameservice Provides information about an HDFS nameservice.
ApiParcel A Parcel encapsulate a specific product and version.
ApiParcelRef A parcelRef references a parcel.
ApiParcelState The ApiParcelState encapsulates the state of a parcel while it is in transition and reports any errors that may have occurred..
ApiParcelUsageHost This object is used to represent a host within an ApiParcelUsage.
ApiParcelUsageParcel This object is used to represent a parcel within an ApiParcelUsage.
ApiParcelUsageRack This object is used to represent a rack within an ApiParcelUsage.
ApiParcelUsageRole This object is used to represent a role within an ApiParcelUsage.
ApiProductVersion
ApiReplicationCommand Information about a replication command.
ApiReplicationSchedule A replication job schedule.
ApiRole A role represents a specific entity that participate in a service.
ApiRole.HaStatus
ApiRole.ZooKeeperServerMode The state of the Zookeeper server.
ApiRoleConfigGroup A role config group contains roles of the same role type sharing the same configuration.
ApiRoleConfigGroupRef
ApiRoleRef A roleRef references a role.
ApiRoleState Represents the configured run state of a role.
ApiRolesToInclude Roles to include during a cluster rolling restart.
ApiRoleTypeConfig Role type configuration information.
ApiRollingUpgradeClusterArgs Rolling upgrade arguments used in the CDH Upgrade Command.
ApiSchedule Base class for commands that can be scheduled in Cloudera Manager.
ApiScheduleInterval Represents the unit for the repeat interval for schedules.
ApiScmDbInfo.ScmDbType Enum for Cloudera Manager DB type.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.
ApiServiceConfig Service and role type configuration.
ApiServiceRef A serviceRef references a service.
ApiServiceState Represents the configured run state of a service.
ApiShutdownReadiness.ShutdownReadinessState Enum for Cloudera Manager shutdown readiness state.
ApiSimpleRollingRestartClusterArgs Basic arguments used for Rolling Restart Cluster commands.
ApiSnapshotCommand Information about snapshot commands.
ApiSnapshotPolicy A snapshot policy.
ApiTimeSeries A time series represents a stream of data points.
ApiTimeSeriesAggregateStatistics Statistics related to one time series aggregate data point.
ApiTimeSeriesCrossEntityMetadata A class holding additional metadata to the ApiTimeSeriesAggregateStatistics class that applies specifically to cross-entity aggregate metrics.
ApiTimeSeriesData A single data point of time series data.
ApiTimeSeriesEntityAttribute A time series entity attribute represents a possible attribute of a time series entity type monitored by the Cloudera Management Services.
ApiTimeSeriesEntityType Describe a time series entity type and attributes associated with this entity type.
ApiTimeSeriesMetadata Metadata for a time series.
ApiTimeSeriesResponse The time series response for a time series query.
ApiTimeSeriesRow A time series data point.
ApiUser This is the model for user information in the API.
ApiUserSession This is the model for interactive user session information in the API.
ApiVersionInfo Version information of Cloudera Manager itself.
ApiWatchedDir
ApiYarnApplication Represents a Yarn application
ApiYarnApplicationAttribute Metadata about a YARN application attribute.

Classes in com.cloudera.api.model used by com.cloudera.api.v1

Class and Description
ApiActivity Represents a user activity, such as a MapReduce job, a Hive query, an Oozie workflow, etc.
ApiActivityList
ApiBulkCommandList A list of commands.
ApiCluster A cluster represents a set of interdependent services running on a set of hosts.
ApiClusterList A list of clusters.
ApiCollectDiagnosticDataArguments Arguments used for the collectDiagnosticData command.
ApiCommand Provides detailed information about a submitted command.
ApiCommandList A list of commands.
ApiConfigList A list of configuration data.
ApiEcho The echoMessage carries a message to be echoed back from the API service.
ApiEvent Events model noteworthy incidents in Cloudera Manager or the managed Hadoop cluster.
ApiEventQueryResult
ApiHdfsDisableHaArguments Arguments used for the HDFS disable HA command.
ApiHdfsFailoverArguments Arguments used when enabling HDFS automatic failover.
ApiHdfsHaArguments Arguments used for HDFS HA commands.
ApiHost This is the model for a host in the system.
ApiHostList A list of ApiHost objects
ApiLicense Information about the Cloudera Manager license.
ApiMetricList A list of ApiMetric objects
ApiNameservice Provides information about an HDFS nameservice.
ApiNameserviceList A list of HDFS nameservices.
ApiRole A role represents a specific entity that participate in a service.
ApiRoleList A list of roles.
ApiRoleNameList A list of role names.
ApiRoleTypeList A list of roles types that exists for a given service.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.
ApiServiceConfig Service and role type configuration.
ApiServiceList A list of services.
ApiUser This is the model for user information in the API.
ApiUserList A list of users.
ApiVersionInfo Version information of Cloudera Manager itself.

Classes in com.cloudera.api.model used by com.cloudera.api.v10

Class and Description
ApiBulkCommandList A list of commands.
ApiCommand Provides detailed information about a submitted command.
ApiMigrateRolesArguments
ApiRoleNameList A list of role names.
ApiRollingUpgradeServicesArgs Arguments used for Rolling Upgrade command.

Classes in com.cloudera.api.model used by com.cloudera.api.v11

Class and Description
ApiCmPeer Information about a Cloudera Manager peer instance.
ApiCmPeerType Enum for CM peer types.
ApiCommand Provides detailed information about a submitted command.
ApiConfigureForKerberosArguments Arguments used to configure a cluster for Kerberos.
ApiHost This is the model for a host in the system.
ApiNameservice Provides information about an HDFS nameservice.
ApiReplicationDiagnosticsCollectionArgs Optional arguments for diagnostics collection.
ApiReplicationScheduleDataLimits This class encapsulates the data limits that we want to put on ApiReplicationSchedule to avoid potential OOME.
ApiReplicationScheduleList A list of replication schedules.
ApiRole A role represents a specific entity that participate in a service.
ApiRoleList A list of roles.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.
ApiTimeSeriesEntityAttributeList A list of ApiTimeSeriesEntityAttribute objects
ApiTimeSeriesEntityTypeList A list of ApiTimeSeriesEntityType objects
ApiTimeSeriesRequest Request object containing information needed for querying timeseries data.
ApiUserSessionList A list of user sessions.

Classes in com.cloudera.api.model used by com.cloudera.api.v12

Class and Description
ApiClusterTemplate Details of cluster template
ApiCommand Provides detailed information about a submitted command.
ApiServiceList A list of services.

Classes in com.cloudera.api.model used by com.cloudera.api.v13

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiReplicationState The state of Hive/HDFS Replication.

Classes in com.cloudera.api.model used by com.cloudera.api.v14

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiExternalAccount Represents an instantiation of an external account type, referencing a supported external account type, via the typeName field, along with suitable configuration to access an external resource of the provided type.
ApiExternalAccountCategoryList Represents a list of external account categories.
ApiExternalAccountList Represents a list of external accounts.
ApiExternalAccountTypeList Represents a list of external account types.
ApiScmDbInfo Cloudera Manager server's database information
ApiWatchedDir
ApiWatchedDirList A list of watched directories.

Classes in com.cloudera.api.model used by com.cloudera.api.v15

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiConfigList A list of configuration data.
ApiHostNameList A list of host names.
ApiRoleNameList A list of role names.
ApiShutdownReadiness Cloudera Manager server's shutdown readiness

Classes in com.cloudera.api.model used by com.cloudera.api.v16

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiCommandMetadataList A list of command metadata.
ApiConfigList A list of configuration data.

Classes in com.cloudera.api.model used by com.cloudera.api.v17

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiHostNameList A list of host names.
ApiKerberosInfo Kerberos information of a Cluster or Cloudera Manager.
ApiRoleNameList A list of role names.

Classes in com.cloudera.api.model used by com.cloudera.api.v2

Class and Description
ApiCluster A cluster represents a set of interdependent services running on a set of hosts.
ApiCommand Provides detailed information about a submitted command.
ApiDeployment This objects represents a deployment including all clusters, hosts, services, roles, etc in the system.
ApiHostNameList A list of host names.
ApiRoleNameList A list of role names.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.

Classes in com.cloudera.api.model used by com.cloudera.api.v3

Class and Description
ApiBulkCommandList A list of commands.
ApiCmPeer Information about a Cloudera Manager peer instance.
ApiCmPeerList A list of Cloudera Manager peers.
ApiCommand Provides detailed information about a submitted command.
ApiConfigList A list of configuration data.
ApiHostRef A reference to a host.
ApiHostRefList A list of host references.
ApiHostTemplate A host template belongs to a cluster and contains a set of role config groups for slave roles (such as DataNodes and TaskTrackers) from services in the cluster.
ApiHostTemplateList A list of host templates.
ApiParcel A Parcel encapsulate a specific product and version.
ApiParcelList A list of ApiParcel.
ApiReplicationSchedule A replication job schedule.
ApiReplicationScheduleList A list of replication schedules.
ApiRoleConfigGroup A role config group contains roles of the same role type sharing the same configuration.
ApiRoleConfigGroupList A list of role config groups.
ApiRoleList A list of roles.
ApiRoleNameList A list of role names.
ApiRollEditsArgs Arguments used for the Roll Edits command.
ApiRollingRestartArgs Arguments used for Rolling Restart commands.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.

Classes in com.cloudera.api.model used by com.cloudera.api.v4

Class and Description
ApiAuditList
ApiBulkCommandList A list of commands.
ApiCommand Provides detailed information about a submitted command.
ApiDisableJtHaArguments Arguments used for disable JT HA command.
ApiEnableJtHaArguments Arguments used for enable JT HA command.
ApiHdfsUsageReport
ApiImpalaCancelResponse The response from an Impala cancel query response.
ApiImpalaQueryDetailsResponse A query details response.
ApiImpalaQueryResponse The response contains a list of queries and warnings.
ApiMetricSchemaList A list of ApiMetricSchema objects
ApiMrUsageReport
ApiProcess A process represents a unix process to be managed by the Cloudera Manager agents.
ApiReplicationCommandList A list of replication commands.
ApiRoleNameList A list of role names.
ApiRollingRestartClusterArgs Arguments used for Rolling Restart Cluster command.
ApiTimeSeriesResponseList

Classes in com.cloudera.api.model used by com.cloudera.api.v5

Class and Description
ApiParcelUsage This object provides a complete view of the usage of parcels in a given cluster - particularly which parcels are in use for which roles.

Classes in com.cloudera.api.model used by com.cloudera.api.v6

Class and Description
ApiBatchRequest A batch request, comprised of one or more request elements.
ApiBatchResponse A batch response, comprised of one or more response elements.
ApiBulkCommandList A list of commands.
ApiCdhUpgradeArgs Arguments used for the CDH Upgrade command.
ApiCluster A cluster represents a set of interdependent services running on a set of hosts.
ApiCommand Provides detailed information about a submitted command.
ApiCommandMetadataList A list of command metadata.
ApiDashboard A dashboard definition.
ApiDashboardList A list of dashboard definitions.
ApiDisableNnHaArguments Arguments used for Disable NameNode High Availability command.
ApiDisableOozieHaArguments
ApiDisableRmHaArguments Arguments used for Disable RM HA command.
ApiEnableNnHaArguments Arguments used for Enable NameNode High Availability command.
ApiEnableOozieHaArguments
ApiEnableRmHaArguments Arguments used for enable RM HA command.
ApiHostInstallArguments Arguments to perform installation on one or more hosts
ApiImpalaQueryAttributeList The list of all the attributes that are applicable to Impala queries.
ApiLicensedFeatureUsage Information about the number of nodes using which product features.
ApiRestartClusterArgs Arguments used for Cluster Restart command.
ApiRoleList A list of roles.
ApiRoleNameList A list of role names.
ApiService A service (such as HDFS, MapReduce, HBase) runs in a cluster.
ApiServiceTypeList A list of service types that exists for a given cluster.
ApiSnapshotCommandList A list of snapshot commands.
ApiSnapshotPolicy A snapshot policy.
ApiSnapshotPolicyList A list of snapshot policies.
ApiYarnApplicationAttributeList The list of all attributes that are applicable to YARN applications.
ApiYarnApplicationResponse The response contains a list of applications and warnings.
ApiYarnKillResponse The response from an Yarn kill application response.

Classes in com.cloudera.api.model used by com.cloudera.api.v7

Class and Description
ApiCommand Provides detailed information about a submitted command.
ApiHostRefList A list of host references.
ApiPrincipalList A list of kerberos principals.

Classes in com.cloudera.api.model used by com.cloudera.api.v8

Class and Description
ApiAuditList
ApiBulkCommandList A list of commands.
ApiCommand Provides detailed information about a submitted command.
ApiDisableLlamaHaArguments Arguments used for disable Llama HA command.
ApiEnableLlamaHaArguments Arguments used for enable Llama HA command.
ApiEnableLlamaRmArguments Arguments used for enable Llama RM command.
ApiRoleNameList A list of role names.
ApiYarnApplicationDiagnosticsCollectionArgs Arguments used for collecting diagnostics data for Yarn applications

Classes in com.cloudera.api.model used by com.cloudera.api.v9

Class and Description
ApiCdhUpgradeArgs Arguments used for the CDH Upgrade command.
ApiCommand Provides detailed information about a submitted command.