com.cloudera.api.swagger.model (cloudera-manager-api-swagger 7.13.1 API)
Date: 2026-05-19

# Package com.cloudera.api.swagger.model

- Class Summary
  Class | Description
  --- | ---
  ApiActivity | Represents a user activity, such as a MapReduce job, a Hive query, an Oozie workflow, etc.
  ApiActivityList | A generic list.
  ApiActivityStatus.Adapter |
  ApiActivityType.Adapter |
  ApiAddCustomCertsArguments | Arguments to add custom certificates to the Auto-TLS certificate database
  ApiAddSBNNToNSArguments | ApiAddSBNNToNSArguments
  ApiAdhocHBaseSnapshot | An HBase snapshot descriptor.
  ApiAdhocSnapshot | An adhoc snapshot descriptor.
  ApiAtlasReplicationArguments | ApiAtlasReplicationArguments
  ApiAtlasReplicationRemoteArgs | ApiAtlasReplicationRemoteArgs
  ApiAtlasReplicationResult | ApiAtlasReplicationResult
  ApiAudit | Models audit events from both CM and CM managed services like HDFS, HBase and Hive.
  ApiAuditList | A generic list.
  ApiAuthRole | This is the model for user role scope in the API since v18.
  ApiAuthRoleAuthority | This represents an authority with a name and description.
  ApiAuthRoleList | A list of auth roles.
  ApiAuthRoleMetadata | This is the model for auth role metadata
  ApiAuthRoleMetadataList | A list of auth roles metadata.
  ApiAuthRoleRef | An authRoleRef to operate on ApiAuthRole object
  ApiBatchRequest | A batch request, comprised of one or more request elements.
  ApiBatchRequestElement | A single element of a batch request, often part of a list with other elements.
  ApiBatchResponse | A batch response, comprised of one or more response elements.
  ApiBatchResponseElement | A single element of a batch response, often part of a list with other elements.
  ApiBulkCommandList | A list of commands.
  ApiCdhUpgradeArgs | Arguments used for the CDH Upgrade command.
  ApiCertificateRequest | This API class represents a request to retrieve Auto-TLS certificates for a given host.
  ApiCluster | A cluster represents a set of interdependent services running on a set of hosts.
  ApiClusterList | A list of clusters.
  ApiClusterNameList | A list of cluster names.
  ApiClusterPerfInspectorArgs | Arguments used for the Cluster Performance Inspector
  ApiClusterRef | A clusterRef references a cluster.
  ApiClustersPerfInspectorArgs | Arguments used for the Cloudera Manager level performance inspector.
  ApiClusterSupportToken | Information about a cluster support token.
  ApiClusterSupportTokenList | A list of cluster support tokens.
  ApiClusterTemplate | Details of cluster template
  ApiClusterTemplateClusterSpec | Specify type of cluster to create.
  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.
  ApiClusterUtilization | Utilization report information of a Cluster.
  ApiClusterVersion.Adapter |
  ApiCmPeer | Information about a Cloudera Manager peer instance.
  ApiCmPeerList | A list of Cloudera Manager peers.
  ApiCmPeerType.Adapter |
  ApiCmServer | This is the model for CM server information from v41.
  ApiCmServerList | A generic list.
  ApiCollectDiagnosticDataArguments | Arguments used for the collectDiagnosticData command.
  ApiCommand | Provides detailed information about a submitted command.
  ApiCommandList | A list of commands.
  ApiCommandMetadata | Provides metadata information about a command.
  ApiCommandMetadataList | A list of command metadata.
  ApiCommandStep | Provides detailed information about a step of a command.
  ApiCommandStepProcess | Provides detailed information about a process executed by a command step.
  ApiCommandWithSteps | Provides detailed information about a submitted command including all steps and a summary of subcommands.
  ApiCommissionState.Adapter |
  ApiComponentInfo | This is the model for a component in the host.
  ApiConfig | Model for a configuration parameter.
  ApiConfigEnforcement | ApiConfigEnforcement
  ApiConfigList | A list of configuration data.
  ApiConfigPolicy | ApiConfigPolicy
  ApiConfigStalenessStatus.Adapter |
  ApiConfigureForKerberosArguments | Arguments used to configure a cluster for Kerberos.
  ApiControlPlane | A Control Plane in a Cloudera Manager instance
  ApiControlPlaneList | A list of ApiControlPlanes
  ApiControlPlaneRef | A controlPlaneRef references a control plane.
  ApiCopyImagesInFeaturesArgs | Arguments used for the command to copy images that belongs to one or more features.
  ApiCreateEnvironment | Arguments used to install CDP a Private Cloud Control Plane
  ApiCspArguments | Arguments to upload CA certificates, client certificates and client key for CSP
  ApiDashboard | A dashboard definition.
  ApiDashboardList | A list of dashboard definitions.
  ApiDataContext | ApiDataContext is the persistent storage/services context exported by the base cluster to be consumed by the compute cluster.
  ApiDataContextList | List of ApiDataContext
  ApiDataContextRef | Reference to an ApiDataContext object.
  ApiDeployment | This objects represents a deployment including all clusters, hosts, services, roles, etc in the system.
  ApiDeployment2 | This objects represents a deployment including all clusters, hosts, services, roles, etc in the system.
  ApiDisableCatalogStatestoreHaArguments | Arguments used for the \"disable Catalog Statestore HA\" command.
  ApiDisableJtHaArguments | Arguments used for disable JT HA command.
  ApiDisableLlamaHaArguments | Arguments used for disable Llama HA command.
  ApiDisableNnHaArguments | Arguments used for Disable NameNode High Availability command.
  ApiDisableOozieHaArguments | ApiDisableOozieHaArguments
  ApiDisableRmHaArguments | Arguments used for Disable RM HA command.
  ApiDisableSentryHaArgs | Arguments used for disable Sentry HA API call.
  ApiEcho | The echoMessage carries a message to be echoed back from the API service.
  ApiEcsDownloadAndDistributeArgs | Represents arguments for downloading and distributing a file from ECS parcel.
  ApiEnableCatalogStatestoreHaArguments | Arguments used for the \"enable Catalog StateStore HA\" command.
  ApiEnableCspArguments | ApiEnableCspArguments
  ApiEnableJtHaArguments | Arguments used for enable JT HA command.
  ApiEnableLlamaHaArguments | Arguments used for enable Llama HA command.
  ApiEnableLlamaRmArguments | Arguments used for enable Llama RM command.
  ApiEnableNnHaArguments | Arguments used for Enable NameNode High Availability command.
  ApiEnableOozieHaArguments | ApiEnableOozieHaArguments
  ApiEnableRmHaArguments | Arguments used for enable RM HA command.
  ApiEnableSentryHaArgs | Arguments used for enable Sentry HA command.
  ApiEndPoint | This defines a single logical service in the SDX cluster.
  ApiEndPointHost | A host endPoint for a service.
  ApiEntityStatus.Adapter |
  ApiEntityTag | Tag associated with an Entity in a Cloudera Manager instance
  ApiEntityType.Adapter |
  ApiEvent | Events model noteworthy incidents in Cloudera Manager or the managed Hadoop cluster.
  ApiEventAttribute | ApiEventAttribute
  ApiEventCategory.Adapter |
  ApiEventQueryResult | A generic list.
  ApiEventSeverity.Adapter |
  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.
  ApiExternalAccountCategoryList | Represents a list of external account categories.
  ApiExternalAccountList | Represents a list of external accounts.
  ApiExternalAccountType | A supported external account type.
  ApiExternalAccountTypeList | Represents a list of external account types.
  ApiExternalUserMapping | This is the model for external user mapping information in the API, v19 and beyond.
  ApiExternalUserMappingList | A list of external user mappings.
  ApiExternalUserMappingRef | An externalUserMappingRef references an externalUserMapping.
  ApiExternalUserMappingType.Adapter |
  ApiGenerateCleanupDockerArgs | Arguments used for the command to generate the docker cleanup script.
  ApiGenerateCmcaArguments | Arguments to generate a Cloudera Manager Certificate Authority (CMCA).
  ApiGenerateCopyDockerArgs | Arguments used for the command to generate the docker copy script.
  ApiGenerateExternalVaultSetupArgs | Arguments used for the command to generate the external vault setup template
  ApiGenerateHostCertsArguments | Arguments to install certificates on a host
  ApiGenericResponse | A generic response object
  ApiHBaseAddReplicationPeerInput | ApiHBaseAddReplicationPeerInput
  ApiHBaseCreateTable | ApiHBaseCreateTable
  ApiHBasePeerId | Encapsulates the ID of an HBase peer.
  ApiHBasePeerIdWithTableCFs | ApiHBasePeerIdWithTableCFs
  ApiHBaseReplicationArguments | Replication arguments for HBase service
  ApiHBaseReplicationInfo | ApiHBaseReplicationInfo
  ApiHBaseReplicationSecurityTool | HBase Replication Security Tool Management
  ApiHBaseReplicationSetupCleanAndResetArgs | ApiHBaseReplicationSetupCleanAndResetArgs
  ApiHBaseReplicationSetupCommandArgs | Command args for HBaseReplicationSetupCommand
  ApiHBaseReplicationSetupOneClusterOnlyCmdArgs | Command args for HBase replication first time setup for only one cluster: either source or target
  ApiHBaseReplicationSetupStatus | Contains status info about the HBase replication first time setup
  ApiHBaseReplicationUpdatePeerStateArgs | Replication arguments for HBase service enabled/disabled peer update
  ApiHBaseSetCFsReplicationScope | ApiHBaseSetCFsReplicationScope
  ApiHBaseShellCommand | API request to execute generic hbase shell command The payload (command) is passed as it is to hbase shell, so the caller needs to know the exact syntax of the supported hbase shell command, based on underlying hbase version
  ApiHBaseSnapshot | An HBase snapshot descriptor.
  ApiHBaseSnapshotError | A HBase snapshot operation error.
  ApiHBaseSnapshotPolicyArguments | HBase specific snapshot policy arguments.
  ApiHBaseSnapshotResult | Detailed information about an HBase snapshot command.
  ApiHBaseTable | An HBase table descriptor.
  ApiHBaseTableNames | Encapsulates table names from HBase.
  ApiHBaseUpdateReplicationPeerState | ApiHBaseUpdateReplicationPeerState
  ApiHdfsCloudReplicationArguments | Replication arguments for HDFS.
  ApiHdfsDisableHaArguments | Arguments used for the HDFS disable HA command.
  ApiHdfsFailoverArguments | Arguments used when enabling HDFS automatic failover.
  ApiHdfsFile | An HDFS file descriptor.
  ApiHdfsHaArguments | Arguments used for HDFS HA commands.
  ApiHdfsReplicationArguments | Replication arguments for HDFS.
  ApiHdfsReplicationCounter | A counter in an HDFS replication job.
  ApiHdfsReplicationResult | Detailed information about an HDFS replication job.
  ApiHdfsReplicationSourcePath | ApiHdfsReplicationSourcePath
  ApiHdfsRestoreSnapshotArgs | HDFS restore snapshot arguments descriptor
  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.
  ApiHdfsSnapshottableDirectoryStatus | An HDFS Snapshottable Directory descriptor.
  ApiHdfsUpgradeDomainList | A map from HDFS upgrade domains to host names, implemented as a list of ApiMapEntryOfHostNameList objects, where the keys are upgrade domain strings and the values are ApiHostNameList objects.
  ApiHdfsUsageReport | A generic list.
  ApiHdfsUsageReportRow | ApiHdfsUsageReportRow
  ApiHealthCheck | Represents a result from a health test performed by Cloudera Manager for an entity.
  ApiHealthSummary.Adapter |
  ApiHive3CloudArguments | API arguments for Hive3 cloud replication
  ApiHive3ReplicationArguments | Replication Arguments for Hive3 schedules / policies
  ApiHive3ReplicationMetric | ApiHive3ReplicationMetric
  ApiHive3ReplicationMetricsMetadata | ApiHive3ReplicationMetricsMetadata
  ApiHive3ReplicationMetricsProgress | ApiHive3ReplicationMetricsProgress
  ApiHive3ReplicationMetricsResultRow | ApiHive3ReplicationMetricsResultRow
  ApiHive3ReplicationMetricsStage | ApiHive3ReplicationMetricsStage
  ApiHive3ReplicationMetricsStatus.Adapter |
  ApiHive3ReplicationQueryResult | A generic list.
  ApiHive3ReplicationQueryResultRow | ApiHive3ReplicationQueryResultRow
  ApiHive3ReplicationScheduledExecutionsResultRow | ApiHive3ReplicationScheduledExecutionsResultRow
  ApiHive3ReplicationScheduledQueriesResultRow | ApiHive3ReplicationScheduledQueriesResultRow
  ApiHiveCloudReplicationArguments | Replication arguments for Hive services.
  ApiHiveOnTezReplicationResult | Detailed information about a Hive replication job.
  ApiHiveReplicationArguments | Replication arguments for Hive services.
  ApiHiveReplicationError | A Hive replication error.
  ApiHiveReplicationResult | Detailed information about a Hive replication job.
  ApiHiveReplicationTableFilters | ApiHiveReplicationTableFilters
  ApiHiveTable | A Hive table identifier.
  ApiHiveUDF | An hive UDF identifier.
  ApiHost | This is the model for a host in the system.
  ApiHostCertInfo | Associates a hostname with its corresponding certificate and private key
  ApiHostInstallArguments | Arguments to perform installation on one or more hosts
  ApiHostList | A list of ApiHost objects
  ApiHostMaintenanceResponse | ApiHostMaintenanceResponse
  ApiHostMaintenanceResponseList | A generic list.
  ApiHostNameList | A list of host names.
  ApiHostRef | A reference to a host.
  ApiHostRefList | A list of host references.
  ApiHostsPerfInspectorArgs | Arguments used for the Cloudera Manager level performance inspector.
  ApiHostsToRemoveArgs | Arguments passed to the remove hosts from cluster api, every host passed in has the roles in it deleted and the host is removed from the cluster, but is still managed by CM.
  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.
  ApiIcebergReplicationAccessStatus | ApiIcebergReplicationAccessStatus
  ApiIcebergReplicationArguments | Replication Arguments for Iceberg Replication policies
  ApiIcebergReplicationRemoteCommand | API request to execute an iceberg remote command The payload (command) is executed by the remote Iceberg Replication service.
  ApiIcebergReplicationResult | Detailed information about an ICEBERG replication job.
  ApiIcebergReplicationTableFilters | ApiIcebergReplicationTableFilters
  ApiImpalaCancelResponse | The response from an Impala cancel query response.
  ApiImpalaQuery | Represents an Impala Query.
  ApiImpalaQueryAttribute | Metadata about an Impala query attribute.
  ApiImpalaQueryAttributeList | The list of all the attributes that are applicable to Impala queries.
  ApiImpalaQueryDetailsResponse | A query details response.
  ApiImpalaQueryResponse | The response contains a list of queries and warnings.
  ApiImpalaRoleDiagnosticsArgs | Arguments used for Rolling Restart commands.
  ApiImpalaTenantUtilization | Utilization report information of a tenant of Impala application.
  ApiImpalaTenantUtilizationList | A list of impala tenant utilization reports.
  ApiImpalaUDF | An impala UDF identifier.
  ApiImpalaUtilization | Utilization report information of a Impala application service.
  ApiImpalaUtilizationHistogram | Histogram of Impala utilization.
  ApiImpalaUtilizationHistogramBin | Histogram bin of Impala utilization.
  ApiImpalaUtilizationHistogramBinList | A generic list.
  ApiInstallControlPlaneArgs | Arguments used to install CDP a Private Cloud Control Plane
  ApiInstallEmbeddedControlPlaneArgs | Arguments used to install a Private Cloud Control Plane on embedded kubernetes
  ApiJceksFile | ApiJceksFile
  ApiJournalNodeArguments | Arguments used as part of ApiEnableNnHaArguments to specify JournalNodes.
  ApiKerberosInfo | Kerberos information of a Cluster or Cloudera Manager.
  ApiLicense | Information about the Cloudera Manager license.
  ApiLicensedFeatureUsage | Information about the number of nodes using which product features.
  ApiLicenseFeature | Information about the Cloudera Manager license feature details.
  ApiListBase | A generic list.
  ApiMapEntry | Models a map entry, with a key and a value.
  ApiMapEntryOfHostNameList | Similar to ApiMapEntry but the value is an ApiHostNameList.
  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.
  ApiMetricList | A list of ApiMetric objects
  ApiMetricSchema | A metric schema represents the schema for a specific metric monitored by the Cloudera Management Services.
  ApiMetricSchemaList | A list of ApiMetricSchema objects
  ApiMigrateRolesArguments | ApiMigrateRolesArguments
  ApiMr2AppInformation | Represents MapReduce2 information for a YARN application.
  ApiMrUsageReport | A generic list.
  ApiMrUsageReportRow | ApiMrUsageReportRow
  ApiNameservice | Provides information about an HDFS nameservice.
  ApiNameserviceList | A list of HDFS nameservices.
  ApiOsDistribution | Definition of an OS distribution.
  ApiOsDistributionType.Adapter |
  ApiOzoneBucketInfo | ApiOzoneBucketInfo
  ApiOzoneBucketRef | Reference to an Ozone bucket.
  ApiOzoneCreateSnapshotReq | Ozone create snapshot request payload
  ApiOzoneDeleteSnapshotListReq | Ozone delete multiple snapshot request payload
  ApiOzoneFilterSpec | Listing filter options for Ozone queries.
  ApiOzoneGetBucketInfoReq | Ozone get bucket info request payload
  ApiOzoneKeyRef | Reference to a key of an Ozone bucket.
  ApiOzoneListBucketsReq | Ozone buckets list request payload
  ApiOzoneListKeysReq | Ozone keys list request payload
  ApiOzoneListSnapshotsReq | Ozone snapshot list request payload
  ApiOzoneListVolumesReq | Ozone volume list request payload
  ApiOzoneReplicationArguments | Replication arguments for HDFS.
  ApiOzoneReplicationCounter | A counter in an HDFS replication job.
  ApiOzoneReplicationResult | Detailed information about an OZONE replication job.
  ApiOzoneResultSpec | Result handling specification
  ApiOzoneS3GatewayInfo | Encapsulates information needed to utilize the s3 Gateway API- namely, the AWS credentials, the rest url of the s3 Gateway and the S3 bucket.
  ApiOzoneSnapshot | Reference to an Ozone snapshot.
  ApiOzoneSnapshotDetails | Reference to an Ozone snapshot details.
  ApiOzoneSnapshotDiffReq | Reference to an Ozone snapshot diff between two snapshots or between a snapshot and current bucket state (in that case #snapshotToName can be empty or null).
  ApiOzoneSnapshotError | An Ozone snapshot operation error.
  ApiOzoneSnapshotInfo | Ozone snapshot information.
  ApiOzoneSnapshotList | Reference to multiple Ozone snapshots from the same volume and bucket.
  ApiOzoneSnapshotPolicyArguments | Ozone specific snapshot policy arguments.
  ApiOzoneSnapshotRestore | Ozone snapshot restore to a destination bucket.
  ApiOzoneSnapshotResult | Detailed information about an Ozone snapshot command.
  ApiParcel | A Parcel encapsulate a specific product and version.
  ApiParcelList | A list of ApiParcel.
  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..
  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.
  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.
  ApiPerfInspectorBandwidthArgs | Arguments to run bandwidth diagnostics as part of performance inspector.
  ApiPerfInspectorPingArgs | Arguments to run ping test.
  ApiPrincipalList | A list of kerberos principals.
  ApiProcess | A process represents a unix process to be managed by the Cloudera Manager agents.
  ApiProductVersion | ApiProductVersion
  ApiRangerPolicy | Holds information about a policy defined in Ranger.
  ApiRangerPolicyList | Holds information about local (#getPolicies()) and remote (#getRemotePolicies()) policies defined in Ranger.
  ApiRangerPolicyResource | Holds information about a policy resource defined in Ranger.
  ApiRangerReplicationArgs | Replication arguments for replicating services defined in Ranger.
  ApiRangerReplicationExportArgs | Arguments for EXPORTING Ranger services and policies, to be replicated later.
  ApiRangerReplicationHdfsToAdlsArgs | Arguments for transforming HDFS Ranger service policies to Azure Data Lake Storage (ADLS) policies.
  ApiRangerReplicationHdfsToGcsArgs | Arguments for transforming HDFS Ranger service policies to Google Cloud Storage (GCS) policies.
  ApiRangerReplicationHdfsToS3Args | Arguments for transforming HDFS Ranger service policies to Amazon S3 policies.
  ApiRangerReplicationImportArgs | Arguments for IMPORTING Ranger services and policies, executed after EXPORT (see ApiRangerReplicationExportArgs) and TRANSFORM (see ApiRangerReplicationTransformArgs).
  ApiRangerReplicationResult | Detailed information about a RANGER replication job.
  ApiRangerReplicationTransformArgs | Arguments for TRANSFORMING Ranger services and policies, executed after EXPORT (see ApiRangerReplicationExportArgs).
  ApiRangerService | Holds information about a service defined in Ranger.
  ApiRangerServiceList | Holds information about local (#getServices()) and remote (#getRemoteServices()) services defined in Ranger.
  ApiRangerUser | Holds information about a user (vXUsers) defined in Ranger.
  ApiRangerUserList | Holds information about local (#getUsers()) and remote (#getRemoteUsers()) users defined in Ranger.
  ApiRemoteCommand | References a command executed on a peer cluster by a local command step.
  ApiRemoteDataContext | This object contains enough information for a Workload cluster to connect to an SDX cluster.
  ApiRemoteRepoUrl | A remote repository URL.
  ApiReplicationCommand | Information about a replication command.
  ApiReplicationCommandList | A list of replication commands.
  ApiReplicationDiagnosticsCollectionArgs | Optional arguments for diagnostics collection.
  ApiReplicationSchedule | A replication job schedule.
  ApiReplicationScheduleDataLimits | This class encapsulates the data limits that we want to put on ApiReplicationSchedule to avoid potential OOME.
  ApiReplicationScheduleList | A list of replication schedules.
  ApiReplicationScheduleListLimits | This class encapsulates the data limits that we want to put on ApiReplicationSchedule to avoid potential OOME.
  ApiReplicationState | The state of Hive/HDFS Replication.
  ApiResponseTypes.Adapter |
  ApiRestartClusterArgs | Arguments used for Cluster Restart command.
  ApiRole | A role represents a specific entity that participate in a service.
  ApiRoleConfig | ApiRoleConfig
  ApiRoleConfigGroup | A role config group contains roles of the same role type sharing the same configuration.
  ApiRoleConfigGroupList | A list of role config groups.
  ApiRoleConfigGroupRef | ApiRoleConfigGroupRef
  ApiRoleConfigList | A generic list.
  ApiRoleList | A list of roles.
  ApiRoleNameList | A list of role names.
  ApiRoleRef | A roleRef references a role.
  ApiRoleState.Adapter |
  ApiRolesToInclude.Adapter |
  ApiRoleTypeConfig | Role type configuration information.
  ApiRoleTypeList | A list of roles types that exists for a given service.
  ApiRollEditsArgs | Arguments used for the Roll Edits command.
  ApiRollingRestartArgs | Arguments used for Rolling Restart commands.
  ApiRollingRestartClusterArgs | Arguments used for Rolling Restart Cluster command.
  ApiRollingUpgradeClusterArgs | Rolling upgrade arguments used in the CDH Upgrade Command.
  ApiRollingUpgradeServicesArgs | Arguments used for Rolling Upgrade command.
  ApiRunSpecificHostInspectionsArgs | ApiRunSpecificHostInspectionsArgs
  ApiSchedule | Base class for commands that can be scheduled in Cloudera Manager.
  ApiScheduleInterval.Adapter |
  ApiScmDbInfo | Cloudera Manager server's database information
  ApiService | A service (such as HDFS, MapReduce, HBase) runs in a cluster.
  ApiServiceConfig | Service and role type configuration.
  ApiServiceList | A list of services.
  ApiServiceRef | A serviceRef references a service.
  ApiServiceState.Adapter |
  ApiServiceTypeList | A list of service types that exists for a given cluster.
  ApiShutdownReadiness | Cloudera Manager server's shutdown readiness
  ApiSimpleRollingRestartClusterArgs | Basic arguments used for Rolling Restart Cluster commands.
  ApiSnapshotCommand | Information about snapshot commands.
  ApiSnapshotCommandList | A list of snapshot commands.
  ApiSnapshotPolicy | A snapshot policy.
  ApiSnapshotPolicyList | A list of snapshot policies.
  ApiStringList | A list of strings.
  ApiTagToEntities | API object which groups types of entities as per the associated tag
  ApiTagToEntitiesList | A list of ApiTagEntities
  ApiTenantUtilization | Utilization report information of a tenant.
  ApiTenantUtilizationList | A list of tenant utilization reports.
  ApiTestCmExternalAuthArguments | ApiTestCmExternalAuthArguments
  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.
  ApiTimeSeriesEntityAttributeList | A list of ApiTimeSeriesEntityAttribute objects
  ApiTimeSeriesEntityType | Describe a time series entity type and attributes associated with this entity type.
  ApiTimeSeriesEntityTypeList | A list of ApiTimeSeriesEntityType objects
  ApiTimeSeriesMetadata | Metadata for a time series.
  ApiTimeSeriesRequest | Request object containing information needed for querying timeseries data.
  ApiTimeSeriesResponse | The time series response for a time series query.
  ApiTimeSeriesResponseList | A generic list.
  ApiUninstallControlPlaneArgs | Arguments used to uninstall CDP a Private Cloud Control Plane
  ApiUpdateControlPlaneValuesYamlArgs | Arguments used to get an existing CDP Private Cloud Control Plane's info
  ApiUpdateCspTypeArguments | ApiUpdateCspTypeArguments
  ApiUpdateGlobalTruststoreArguments | Arguments to update certificates from the Auto-TLS truststore
  ApiUpgradeControlPlaneArgs | Arguments used to upgrade a CDP Private Cloud Control Plane
  ApiUpgradeEmbeddedControlPlaneArgs | Arguments used to upgrade a Private Cloud Control Plane on embedded kubernetes and the associated Containerized Cluster.
  ApiUser | This is the model for user information in the API prior to v18.
  ApiUser2 | This is the model for user information in the API, v18 and beyond.
  ApiUser2List | A list of users.
  ApiUser2Ref | A userRef references a user.
  ApiUserList | A list of users.
  ApiUserSession | This is the model for interactive user session information in the API.
  ApiUserSessionList | A list of user sessions.
  ApiVersionInfo | Version information of Cloudera Manager itself.
  ApiWatchedDir | ApiWatchedDir
  ApiWatchedDirList | A list of watched directories.
  ApiYarnApplication | Represents a Yarn application
  ApiYarnApplicationAttribute | Metadata about a YARN application attribute.
  ApiYarnApplicationAttributeList | The list of all attributes that are applicable to YARN applications.
  ApiYarnApplicationDiagnosticsCollectionArgs | Arguments used for collecting diagnostics data for Yarn applications
  ApiYarnApplicationResponse | The response contains a list of applications and warnings.
  ApiYarnKillResponse | The response from an Yarn kill application response.
  ApiYarnTenantUtilization | Utilization report information of a tenant of Yarn application.
  ApiYarnTenantUtilizationList | A list of yarn tenant utilization reports.
  ApiYarnUtilization | Utilization report information of a Yarn application service.
  BaseApiSshCmdArguments | Contains common arguments for commands which require SSH'ing into one or more hosts.
  CmLicenseBody | CmLicenseBody
  DeleteHdfsPathResult.Adapter |
  HaStatus.Adapter |
  HBaseDatabaseArgs | Holds information for an HBase all database replication.
  HBasePeerState.Adapter |
  HBaseTableArgs | Holds information for an HBase table.
  HBaseWholeDbReplicationStrategy.Adapter |
  HTTPMethod.Adapter |
  IcebergReplicationSafetyValve | IcebergReplicationSafetyValve
  IcebergReplicationYarnOptions | IcebergReplicationYarnOptions
  Origin.Adapter |
  OzoneReplicationCommandType.Adapter |
  OzoneReplicationType.Adapter |
  PerfInspectorPolicyType.Adapter |
  PolicyStatus.Adapter |
  RangerReplicationImportStrategy.Adapter |
  ReplicationOption.Adapter |
  ReplicationStrategy.Adapter |
  ReplicationType.Adapter |
  RestartType.Adapter |
  ScmDbType.Adapter |
  ShutdownReadinessState.Adapter |
  SourceStorageFilter.Adapter |
  State.Adapter |
  Status.Adapter |
  Storage.Adapter |
  StreamingOutput | StreamingOutput
  SubStatus.Adapter |
  ValidationState.Adapter |
  ZooKeeperServerMode.Adapter |

- Enum Summary
  Enum | Description
  --- | ---
  ApiActivityStatus | Gets or Sets ApiActivityStatus
  ApiActivityType | Gets or Sets ApiActivityType
  ApiClusterVersion | The CDH version of the cluster.
  ApiCmPeerType | Enum for CM peer types.
  ApiCommissionState | Represents the Commission state of an entity.
  ApiConfigStalenessStatus | Represents the configuration staleness status of an entity.
  ApiEntityStatus | The single value used by the Cloudera Manager UI to represent the status of the entity.
  ApiEntityType | Represents the types of entities.
  ApiEventCategory | Gets or Sets ApiEventCategory
  ApiEventSeverity | Gets or Sets ApiEventSeverity
  ApiExternalUserMappingType | Enum for external user mapping types
  ApiHealthSummary | Represents of the high-level health status of a subject in the cluster.
  ApiHive3ReplicationMetricsStatus | Gets or Sets ApiHive3ReplicationMetricsStatus
  ApiOsDistributionType | Allowed OS distribution types.
  ApiResponseTypes | Gets or Sets ApiResponseTypes
  ApiRoleState | Represents the configured run state of a role.
  ApiRolesToInclude | Roles to include during a cluster rolling restart.
  ApiScheduleInterval | Represents the unit for the repeat interval for schedules.
  ApiServiceState | Represents the configured run state of a service.
  DeleteHdfsPathResult | Gets or Sets DeleteHdfsPathResult
  HaStatus | Gets or Sets HaStatus
  HBasePeerState | Gets or Sets HBasePeerState
  HBaseWholeDbReplicationStrategy | HBase whole DB replication strategies
  HTTPMethod | Gets or Sets HTTPMethod
  Origin | Gets or Sets Origin
  OzoneReplicationCommandType | Gets or Sets OzoneReplicationCommandType
  OzoneReplicationType | Gets or Sets OzoneReplicationType
  PerfInspectorPolicyType | Enum to pick the type of Performance Inspector Diagnostics to run
  PolicyStatus | Gets or Sets PolicyStatus
  RangerReplicationImportStrategy | The strategy to be used for Ranger replication import step.
  ReplicationOption | This will decide how cloud replication will take place
  ReplicationStrategy | The strategy for distributing the file replication tasks among the mappers of the MR job associated with a replication.
  ReplicationType | Gets or Sets ReplicationType
  RestartType | Restart type to be used for restarting services
  ScmDbType | Enum for Cloudera Manager DB type.
  ShutdownReadinessState | Enum for Cloudera Manager shutdown readiness state.
  SourceStorageFilter | Gets or Sets SourceStorageFilter
  State | Gets or Sets State
  Status | Gets or Sets Status
  Storage | Gets or Sets Storage
  SubStatus | Gets or Sets SubStatus
  ValidationState | Gets or Sets ValidationState
  ZooKeeperServerMode | The state of the Zookeeper server.

Copyright © 2026. All rights reserved.