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

## Uses of Class
com.cloudera.api.swagger.model.ApiServiceRef

- Packages that use ApiServiceRef
  Package | Description
  --- | ---
  com.cloudera.api.swagger |
  com.cloudera.api.swagger.model |

- - ### Uses of ApiServiceRef in com.cloudera.api.swagger

    Methods in com.cloudera.api.swagger with parameters of type ApiServiceRef
    Modifier and Type | Method and Description
    --- | ---
    `ApiCommand` | ServicesResourceApi.`copyHdfsFile(String clusterName, String serviceName, ApiServiceRef body, String destinationPath, String sourcePath)` Copies source HDFS file to destination cluster HDFS.
    `okhttp3.Call` | ServicesResourceApi.`copyHdfsFileAsync(String clusterName, String serviceName, ApiServiceRef body, String destinationPath, String sourcePath, ApiCallback<ApiCommand> callback)` Copies source HDFS file to destination cluster HDFS.
    `okhttp3.Call` | ServicesResourceApi.`copyHdfsFileCall(String clusterName, String serviceName, ApiServiceRef body, String destinationPath, String sourcePath, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for copyHdfsFile
    `ApiResponse<ApiCommand>` | ServicesResourceApi.`copyHdfsFileWithHttpInfo(String clusterName, String serviceName, ApiServiceRef body, String destinationPath, String sourcePath)` Copies source HDFS file to destination cluster HDFS.
    `ApiCommand` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForAlreadyPairedClusters(String clusterName, String serviceName, ApiServiceRef body, Boolean force)` Starts an HBase replication first time setup for the source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForAlreadyPairedClustersAsync(String clusterName, String serviceName, ApiServiceRef body, Boolean force, ApiCallback<ApiCommand> callback)` Starts an HBase replication first time setup for the source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForAlreadyPairedClustersCall(String clusterName, String serviceName, ApiServiceRef body, Boolean force, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for hbaseReplicationFirstTimeSetupForAlreadyPairedClusters
    `ApiResponse<ApiCommand>` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForAlreadyPairedClustersWithHttpInfo(String clusterName, String serviceName, ApiServiceRef body, Boolean force)` Starts an HBase replication first time setup for the source and target.
    `void` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForceReady(String clusterName, String serviceName, ApiServiceRef body)` Force sets the HBase replication first time setup status to be READY for the given source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForceReadyAsync(String clusterName, String serviceName, ApiServiceRef body, ApiCallback<Void> callback)` Force sets the HBase replication first time setup status to be READY for the given source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForceReadyCall(String clusterName, String serviceName, ApiServiceRef body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for hbaseReplicationFirstTimeSetupForceReady
    `ApiResponse<Void>` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupForceReadyWithHttpInfo(String clusterName, String serviceName, ApiServiceRef body)` Force sets the HBase replication first time setup status to be READY for the given source and target.
    `ApiCommand` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupManualContinue(String clusterName, String serviceName, ApiServiceRef body)` Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupManualContinueAsync(String clusterName, String serviceName, ApiServiceRef body, ApiCallback<ApiCommand> callback)` Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupManualContinueCall(String clusterName, String serviceName, ApiServiceRef body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for hbaseReplicationFirstTimeSetupManualContinue
    `ApiResponse<ApiCommand>` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupManualContinueWithHttpInfo(String clusterName, String serviceName, ApiServiceRef body)` Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.
    `void` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupReset(String clusterName, String serviceName, ApiServiceRef body)` Resets/removes the HBase replication first time setup status for the given source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupResetAsync(String clusterName, String serviceName, ApiServiceRef body, ApiCallback<Void> callback)` Resets/removes the HBase replication first time setup status for the given source and target.
    `okhttp3.Call` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupResetCall(String clusterName, String serviceName, ApiServiceRef body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for hbaseReplicationFirstTimeSetupReset
    `ApiResponse<Void>` | ServicesResourceApi.`hbaseReplicationFirstTimeSetupResetWithHttpInfo(String clusterName, String serviceName, ApiServiceRef body)` Resets/removes the HBase replication first time setup status for the given source and target.

  - ### Uses of ApiServiceRef in com.cloudera.api.swagger.model

    Methods in com.cloudera.api.swagger.model that return ApiServiceRef
    Modifier and Type | Method and Description
    --- | ---
    `ApiServiceRef` | ApiServiceRef.`clusterDisplayName(String clusterDisplayName)`
    `ApiServiceRef` | ApiServiceRef.`clusterName(String clusterName)`
    `ApiServiceRef` | ApiRoleConfigGroup.`getServiceRef()` Get serviceRef
    `ApiServiceRef` | ApiRole.`getServiceRef()` Get serviceRef
    `ApiServiceRef` | ApiCommand.`getServiceRef()` Get serviceRef
    `ApiServiceRef` | ApiHBaseReplicationArguments.`getSourceHBaseService()` Get sourceHBaseService
    `ApiServiceRef` | ApiHive3ReplicationArguments.`getSourceHiveService()` Get sourceHiveService
    `ApiServiceRef` | ApiIcebergReplicationArguments.`getSourceIcebergReplicationService()` Get sourceIcebergReplicationService
    `ApiServiceRef` | ApiRangerReplicationArgs.`getSourceRangerService()` Get sourceRangerService
    `ApiServiceRef` | ApiHBaseReplicationUpdatePeerStateArgs.`getSourceRef()` Get sourceRef
    `ApiServiceRef` | ApiHBaseReplicationSetupOneClusterOnlyCmdArgs.`getSourceRef()` Get sourceRef
    `ApiServiceRef` | ApiHBaseReplicationSetupCommandArgs.`getSourceRef()` Get sourceRef
    `ApiServiceRef` | ApiHBaseReplicationSetupCleanAndResetArgs.`getSourceRef()` Get sourceRef
    `ApiServiceRef` | ApiHiveReplicationArguments.`getSourceService()` Get sourceService
    `ApiServiceRef` | ApiHdfsReplicationArguments.`getSourceService()` Get sourceService
    `ApiServiceRef` | ApiAtlasReplicationRemoteArgs.`getSourceService()` Get sourceService
    `ApiServiceRef` | ApiAtlasReplicationArguments.`getSourceService()` Get sourceService
    `ApiServiceRef` | ApiAdhocHBaseSnapshot.`getSourceService()` Get sourceService
    `ApiServiceRef` | ApiHdfsFailoverArguments.`getZooKeeperService()` Get zooKeeperService
    `ApiServiceRef` | ApiServiceRef.`peerName(String peerName)`
    `ApiServiceRef` | ApiServiceRef.`serviceDisplayName(String serviceDisplayName)`
    `ApiServiceRef` | ApiServiceRef.`serviceName(String serviceName)`
    `ApiServiceRef` | ApiServiceRef.`serviceType(String serviceType)`

    Methods in com.cloudera.api.swagger.model that return types with arguments of type ApiServiceRef
    Modifier and Type | Method and Description
    --- | ---
    `List<ApiServiceRef>` | ApiTagToEntities.`getApiServiceRefs()` Get apiServiceRefs
    `List<ApiServiceRef>` | ApiDataContext.`getServices()` Get services
    `List<ApiServiceRef>` | ApiCommandStep.`getServices()` List of services associated with command step.

    Methods in com.cloudera.api.swagger.model with parameters of type ApiServiceRef
    Modifier and Type | Method and Description
    --- | ---
    `ApiTagToEntities` | ApiTagToEntities.`addApiServiceRefsItem(ApiServiceRef apiServiceRefsItem)`
    `ApiDataContext` | ApiDataContext.`addServicesItem(ApiServiceRef servicesItem)`
    `ApiCommandStep` | ApiCommandStep.`addServicesItem(ApiServiceRef servicesItem)`
    `ApiRoleConfigGroup` | ApiRoleConfigGroup.`serviceRef(ApiServiceRef serviceRef)`
    `ApiRole` | ApiRole.`serviceRef(ApiServiceRef serviceRef)`
    `ApiCommand` | ApiCommand.`serviceRef(ApiServiceRef serviceRef)`
    `void` | ApiRoleConfigGroup.`setServiceRef(ApiServiceRef serviceRef)`
    `void` | ApiRole.`setServiceRef(ApiServiceRef serviceRef)`
    `void` | ApiCommand.`setServiceRef(ApiServiceRef serviceRef)`
    `void` | ApiHBaseReplicationArguments.`setSourceHBaseService(ApiServiceRef sourceHBaseService)`
    `void` | ApiHive3ReplicationArguments.`setSourceHiveService(ApiServiceRef sourceHiveService)`
    `void` | ApiIcebergReplicationArguments.`setSourceIcebergReplicationService(ApiServiceRef sourceIcebergReplicationService)`
    `void` | ApiRangerReplicationArgs.`setSourceRangerService(ApiServiceRef sourceRangerService)`
    `void` | ApiHBaseReplicationUpdatePeerStateArgs.`setSourceRef(ApiServiceRef sourceRef)`
    `void` | ApiHBaseReplicationSetupOneClusterOnlyCmdArgs.`setSourceRef(ApiServiceRef sourceRef)`
    `void` | ApiHBaseReplicationSetupCommandArgs.`setSourceRef(ApiServiceRef sourceRef)`
    `void` | ApiHBaseReplicationSetupCleanAndResetArgs.`setSourceRef(ApiServiceRef sourceRef)`
    `void` | ApiHiveReplicationArguments.`setSourceService(ApiServiceRef sourceService)`
    `void` | ApiHdfsReplicationArguments.`setSourceService(ApiServiceRef sourceService)`
    `void` | ApiAtlasReplicationRemoteArgs.`setSourceService(ApiServiceRef sourceService)`
    `void` | ApiAtlasReplicationArguments.`setSourceService(ApiServiceRef sourceService)`
    `void` | ApiAdhocHBaseSnapshot.`setSourceService(ApiServiceRef sourceService)`
    `void` | ApiHdfsFailoverArguments.`setZooKeeperService(ApiServiceRef zooKeeperService)`
    `ApiHBaseReplicationArguments` | ApiHBaseReplicationArguments.`sourceHBaseService(ApiServiceRef sourceHBaseService)`
    `ApiHive3ReplicationArguments` | ApiHive3ReplicationArguments.`sourceHiveService(ApiServiceRef sourceHiveService)`
    `ApiIcebergReplicationArguments` | ApiIcebergReplicationArguments.`sourceIcebergReplicationService(ApiServiceRef sourceIcebergReplicationService)`
    `ApiRangerReplicationArgs` | ApiRangerReplicationArgs.`sourceRangerService(ApiServiceRef sourceRangerService)`
    `ApiHBaseReplicationUpdatePeerStateArgs` | ApiHBaseReplicationUpdatePeerStateArgs.`sourceRef(ApiServiceRef sourceRef)`
    `ApiHBaseReplicationSetupOneClusterOnlyCmdArgs` | ApiHBaseReplicationSetupOneClusterOnlyCmdArgs.`sourceRef(ApiServiceRef sourceRef)`
    `ApiHBaseReplicationSetupCommandArgs` | ApiHBaseReplicationSetupCommandArgs.`sourceRef(ApiServiceRef sourceRef)`
    `ApiHBaseReplicationSetupCleanAndResetArgs` | ApiHBaseReplicationSetupCleanAndResetArgs.`sourceRef(ApiServiceRef sourceRef)`
    `ApiHiveReplicationArguments` | ApiHiveReplicationArguments.`sourceService(ApiServiceRef sourceService)`
    `ApiHdfsReplicationArguments` | ApiHdfsReplicationArguments.`sourceService(ApiServiceRef sourceService)`
    `ApiAtlasReplicationRemoteArgs` | ApiAtlasReplicationRemoteArgs.`sourceService(ApiServiceRef sourceService)`
    `ApiAtlasReplicationArguments` | ApiAtlasReplicationArguments.`sourceService(ApiServiceRef sourceService)`
    `ApiAdhocHBaseSnapshot` | ApiAdhocHBaseSnapshot.`sourceService(ApiServiceRef sourceService)`
    `ApiHdfsFailoverArguments` | ApiHdfsFailoverArguments.`zooKeeperService(ApiServiceRef zooKeeperService)`

    Method parameters in com.cloudera.api.swagger.model with type arguments of type ApiServiceRef
    Modifier and Type | Method and Description
    --- | ---
    `ApiTagToEntities` | ApiTagToEntities.`apiServiceRefs(List<ApiServiceRef> apiServiceRefs)`
    `ApiDataContext` | ApiDataContext.`services(List<ApiServiceRef> services)`
    `ApiCommandStep` | ApiCommandStep.`services(List<ApiServiceRef> services)`
    `void` | ApiTagToEntities.`setApiServiceRefs(List<ApiServiceRef> apiServiceRefs)`
    `void` | ApiDataContext.`setServices(List<ApiServiceRef> services)`
    `void` | ApiCommandStep.`setServices(List<ApiServiceRef> services)`

Copyright © 2026. All rights reserved.