Package com.cloudera.cdp.dw.api
Class DwClient
- java.lang.Object
-
- com.cloudera.cdp.client.CdpClient
-
- com.cloudera.cdp.dw.api.DwClient
-
@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen", date="2023-09-14T10:47:17.249-07:00") public class DwClient extends CdpClient
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_NAME
-
Fields inherited from class com.cloudera.cdp.client.CdpClient
NO_EXTENSION
-
-
Constructor Summary
Constructors Constructor Description DwClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
DwClient(CdpRequestContext<?> context)
-
Method Summary
-
Methods inherited from class com.cloudera.cdp.client.CdpClient
invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown
-
-
-
-
Field Detail
-
SERVICE_NAME
public static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DwClient
public DwClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
-
DwClient
public DwClient(CdpRequestContext<?> context)
-
-
Method Detail
-
getServiceName
protected String getServiceName()
Description copied from class:CdpClient
Gets the service name.- Specified by:
getServiceName
in classCdpClient
- Returns:
- the service name
-
getRequestContentType
protected String getRequestContentType()
Description copied from class:CdpClient
Gets the request Content-Type, used by 'Conent-Type' request header.- Overrides:
getRequestContentType
in classCdpClient
- Returns:
- the request Content-Type
-
getResponseContentType
protected String getResponseContentType()
Description copied from class:CdpClient
Gets the expected response Content-Type, used by 'Accept' request header.- Overrides:
getResponseContentType
in classCdpClient
- Returns:
- the response Content-Type
-
addUser
public AddUserResponse addUser(AddUserRequest input)
Adds the given user to the cluster.- Parameters:
input
-- Returns:
- AddUserResponse
-
backupCluster
public BackupClusterResponse backupCluster(BackupClusterRequest input)
Creates a backup from the cluster configuration and settings.- Parameters:
input
-- Returns:
- BackupClusterResponse
-
createBackup
public CreateBackupResponse createBackup(CreateBackupRequest input)
Creates a backup for the data warehouse.- Parameters:
input
-- Returns:
- CreateBackupResponse
-
createCluster
public CreateClusterResponse createCluster(CreateClusterRequest input)
Create a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- CreateClusterResponse
-
createClusterDiagnosticDataJob
public CreateClusterDiagnosticDataJobResponse createClusterDiagnosticDataJob(CreateClusterDiagnosticDataJobRequest input)
Create a diagnostic job for the given cluster.- Parameters:
input
-- Returns:
- CreateClusterDiagnosticDataJobResponse
-
createDataVisualization
public CreateDataVisualizationResponse createDataVisualization(CreateDataVisualizationRequest input)
Creates a Cloudera Data Visualization.- Parameters:
input
-- Returns:
- CreateDataVisualizationResponse
-
createDbc
@Deprecated public CreateDbcResponse createDbc(CreateDbcRequest input)
Deprecated.Create a Database Catalog.- Parameters:
input
-- Returns:
- CreateDbcResponse
-
createDbcDiagnosticDataJob
public CreateDbcDiagnosticDataJobResponse createDbcDiagnosticDataJob(CreateDbcDiagnosticDataJobRequest input)
Create a diagnostic job for the given database catalog.- Parameters:
input
-- Returns:
- CreateDbcDiagnosticDataJobResponse
-
createVw
public CreateVwResponse createVw(CreateVwRequest input)
Create a Virtual Warehouse.- Parameters:
input
-- Returns:
- CreateVwResponse
-
createVwDiagnosticDataJob
public CreateVwDiagnosticDataJobResponse createVwDiagnosticDataJob(CreateVwDiagnosticDataJobRequest input)
Create a diagnostic job for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- CreateVwDiagnosticDataJobResponse
-
deleteBackup
public DeleteBackupResponse deleteBackup(DeleteBackupRequest input)
Deletes a data warehouse backup.- Parameters:
input
-- Returns:
- DeleteBackupResponse
-
deleteCluster
public DeleteClusterResponse deleteCluster(DeleteClusterRequest input)
Delete a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DeleteClusterResponse
-
deleteClusterDiagnosticDataJob
public DeleteClusterDiagnosticDataJobResponse deleteClusterDiagnosticDataJob(DeleteClusterDiagnosticDataJobRequest input)
Deletes a diagnostic job for the given cluster.- Parameters:
input
-- Returns:
- DeleteClusterDiagnosticDataJobResponse
-
deleteDataVisualization
public DeleteDataVisualizationResponse deleteDataVisualization(DeleteDataVisualizationRequest input)
Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.- Parameters:
input
-- Returns:
- DeleteDataVisualizationResponse
-
deleteDbc
public DeleteDbcResponse deleteDbc(DeleteDbcRequest input)
Delete a Database Catalog.- Parameters:
input
-- Returns:
- DeleteDbcResponse
-
deleteDbcDiagnosticDataJob
public DeleteDbcDiagnosticDataJobResponse deleteDbcDiagnosticDataJob(DeleteDbcDiagnosticDataJobRequest input)
Deletes a diagnostic job for the given Database Catalog.- Parameters:
input
-- Returns:
- DeleteDbcDiagnosticDataJobResponse
-
deleteUser
public DeleteUserResponse deleteUser(DeleteUserRequest input)
Deletes the given user from the cluster.- Parameters:
input
-- Returns:
- DeleteUserResponse
-
deleteVw
public DeleteVwResponse deleteVw(DeleteVwRequest input)
Delete a Virtual Warehouse.- Parameters:
input
-- Returns:
- DeleteVwResponse
-
deleteVwDiagnosticDataJob
public DeleteVwDiagnosticDataJobResponse deleteVwDiagnosticDataJob(DeleteVwDiagnosticDataJobRequest input)
Delete a diagnostic job for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- DeleteVwDiagnosticDataJobResponse
-
describeAllowedInstanceTypes
public DescribeAllowedInstanceTypesResponse describeAllowedInstanceTypes(DescribeAllowedInstanceTypesRequest input)
Get allowed compute instance types for both AWS and Azure cluster types and their default values.- Parameters:
input
-- Returns:
- DescribeAllowedInstanceTypesResponse
-
describeBackup
public DescribeBackupResponse describeBackup(DescribeBackupRequest input)
Describes the backup.- Parameters:
input
-- Returns:
- DescribeBackupResponse
-
describeCluster
public DescribeClusterResponse describeCluster(DescribeClusterRequest input)
Describe a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DescribeClusterResponse
-
describeClusterDiagnosticDataJob
public DescribeClusterDiagnosticDataJobResponse describeClusterDiagnosticDataJob(DescribeClusterDiagnosticDataJobRequest input)
Describes a diagnostic job for the given Cluster.- Parameters:
input
-- Returns:
- DescribeClusterDiagnosticDataJobResponse
-
describeConfig
public DescribeConfigResponse describeConfig(DescribeConfigRequest input)
Describe a service configuration.- Parameters:
input
-- Returns:
- DescribeConfigResponse
-
describeConfigDiff
public DescribeConfigDiffResponse describeConfigDiff(DescribeConfigDiffRequest input)
Get differences between two service configurations.- Parameters:
input
-- Returns:
- DescribeConfigDiffResponse
-
describeDataVisualization
public DescribeDataVisualizationResponse describeDataVisualization(DescribeDataVisualizationRequest input)
Describes a Cloudera Data Visualization.- Parameters:
input
-- Returns:
- DescribeDataVisualizationResponse
-
describeDbc
public DescribeDbcResponse describeDbc(DescribeDbcRequest input)
Describe a Database Catalog.- Parameters:
input
-- Returns:
- DescribeDbcResponse
-
describeDbcConfig
public DescribeDbcConfigResponse describeDbcConfig(DescribeDbcConfigRequest input)
Describes the Database Catalog current configuration.- Parameters:
input
-- Returns:
- DescribeDbcConfigResponse
-
describeDbcDiagnosticDataJob
public DescribeDbcDiagnosticDataJobResponse describeDbcDiagnosticDataJob(DescribeDbcDiagnosticDataJobRequest input)
Describes a diagnostic job for the given Database Catalog.- Parameters:
input
-- Returns:
- DescribeDbcDiagnosticDataJobResponse
-
describeKubeconfig
public DescribeKubeconfigResponse describeKubeconfig(DescribeKubeconfigRequest input)
Get Kubeconfig for a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DescribeKubeconfigResponse
-
describeRestore
public DescribeRestoreResponse describeRestore(DescribeRestoreRequest input)
Describes the restore.- Parameters:
input
-- Returns:
- DescribeRestoreResponse
-
describeServerSetting
public DescribeServerSettingResponse describeServerSetting(DescribeServerSettingRequest input)
Get the DWX server settings.- Parameters:
input
-- Returns:
- DescribeServerSettingResponse
-
describeVw
public DescribeVwResponse describeVw(DescribeVwRequest input)
Describe a Virtual Warehouse.- Parameters:
input
-- Returns:
- DescribeVwResponse
-
describeVwConfig
public DescribeVwConfigResponse describeVwConfig(DescribeVwConfigRequest input)
Describes the current configuration of a Hive or Impala Virtual Warehouse.- Parameters:
input
-- Returns:
- DescribeVwConfigResponse
-
describeVwDiagnosticDataJob
public DescribeVwDiagnosticDataJobResponse describeVwDiagnosticDataJob(DescribeVwDiagnosticDataJobRequest input)
Describe a diagnostic jobs for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- DescribeVwDiagnosticDataJobResponse
-
getDataVisualizationUpgradeVersion
public GetDataVisualizationUpgradeVersionResponse getDataVisualizationUpgradeVersion(GetDataVisualizationUpgradeVersionRequest input)
Gets latest version and latest compatible version for Cloudera Data Visualization.- Parameters:
input
-- Returns:
- GetDataVisualizationUpgradeVersionResponse
-
getLogs
public GetLogsResponse getLogs(GetLogsRequest input)
Gets job logs.- Parameters:
input
-- Returns:
- GetLogsResponse
-
getUpgradeDbcVersions
public GetUpgradeDbcVersionsResponse getUpgradeDbcVersions(GetUpgradeDbcVersionsRequest input)
Gets the latest version and latest compatible version for Database Catalog.- Parameters:
input
-- Returns:
- GetUpgradeDbcVersionsResponse
-
getUpgradeVwVersions
public GetUpgradeVwVersionsResponse getUpgradeVwVersions(GetUpgradeVwVersionsRequest input)
Gets the latest version and latest compatible version for Virtual Warehouse.- Parameters:
input
-- Returns:
- GetUpgradeVwVersionsResponse
-
healthCheck
public HealthCheckResponse healthCheck(HealthCheckRequest input)
Check the health of the API.- Parameters:
input
-- Returns:
- HealthCheckResponse
-
listBackupEntities
public ListBackupEntitiesResponse listBackupEntities(ListBackupEntitiesRequest input)
Lists potential backup entities associated with the data warehouse.- Parameters:
input
-- Returns:
- ListBackupEntitiesResponse
-
listBackups
public ListBackupsResponse listBackups(ListBackupsRequest input)
Lists backups.- Parameters:
input
-- Returns:
- ListBackupsResponse
-
listClusterDiagnosticDataJobs
public ListClusterDiagnosticDataJobsResponse listClusterDiagnosticDataJobs(ListClusterDiagnosticDataJobsRequest input)
Get a list of diagnostic jobs for the given cluster.- Parameters:
input
-- Returns:
- ListClusterDiagnosticDataJobsResponse
-
listClusters
public ListClustersResponse listClusters(ListClustersRequest input)
List Cloudera Data Warehouse clusters.- Parameters:
input
-- Returns:
- ListClustersResponse
-
listDataVisualizations
public ListDataVisualizationsResponse listDataVisualizations(ListDataVisualizationsRequest input)
Lists Cloudera Data Visualization in the provided CDW cluster.- Parameters:
input
-- Returns:
- ListDataVisualizationsResponse
-
listDbcConfigs
public ListDbcConfigsResponse listDbcConfigs(ListDbcConfigsRequest input)
Get the configuration history of a Database Catalog.- Parameters:
input
-- Returns:
- ListDbcConfigsResponse
-
listDbcDiagnosticDataJobs
public ListDbcDiagnosticDataJobsResponse listDbcDiagnosticDataJobs(ListDbcDiagnosticDataJobsRequest input)
Get a list of diagnostic jobs for the given Database Catalog.- Parameters:
input
-- Returns:
- ListDbcDiagnosticDataJobsResponse
-
listDbcEvents
public ListDbcEventsResponse listDbcEvents(ListDbcEventsRequest input)
Get the list of events for the given Database Catalog.- Parameters:
input
-- Returns:
- ListDbcEventsResponse
-
listDbcs
public ListDbcsResponse listDbcs(ListDbcsRequest input)
List Database Catalogs.- Parameters:
input
-- Returns:
- ListDbcsResponse
-
listLatestVersions
public ListLatestVersionsResponse listLatestVersions(ListLatestVersionsRequest input)
Lists the latest version of the product (if available) for all catalogs in the environment.- Parameters:
input
-- Returns:
- ListLatestVersionsResponse
-
listRestores
public ListRestoresResponse listRestores(ListRestoresRequest input)
Lists restores.- Parameters:
input
-- Returns:
- ListRestoresResponse
-
listUsers
public ListUsersResponse listUsers(ListUsersRequest input)
Lists the users who have access to the cluster.- Parameters:
input
-- Returns:
- ListUsersResponse
-
listVwConfigs
public ListVwConfigsResponse listVwConfigs(ListVwConfigsRequest input)
Get the configuration history of a Virtual Warehouse.- Parameters:
input
-- Returns:
- ListVwConfigsResponse
-
listVwDiagnosticDataJobs
public ListVwDiagnosticDataJobsResponse listVwDiagnosticDataJobs(ListVwDiagnosticDataJobsRequest input)
Get a list of diagnostic jobs for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- ListVwDiagnosticDataJobsResponse
-
listVwEvents
public ListVwEventsResponse listVwEvents(ListVwEventsRequest input)
Get the list of events for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- ListVwEventsResponse
-
listVws
public ListVwsResponse listVws(ListVwsRequest input)
List Virtual Warehouses.- Parameters:
input
-- Returns:
- ListVwsResponse
-
rebuildDbc
public RebuildDbcResponse rebuildDbc(RebuildDbcRequest input)
Rebuild a Database Catalog.- Parameters:
input
-- Returns:
- RebuildDbcResponse
-
rebuildVw
public RebuildVwResponse rebuildVw(RebuildVwRequest input)
Rebuild a Virtual Warehouse.- Parameters:
input
-- Returns:
- RebuildVwResponse
-
renewCertificates
public RenewCertificatesResponse renewCertificates(RenewCertificatesRequest input)
Renew certificates for a Cloudera Data Warehouse Azure cluster.- Parameters:
input
-- Returns:
- RenewCertificatesResponse
-
restartDbc
public RestartDbcResponse restartDbc(RestartDbcRequest input)
Restart a Database Catalog.- Parameters:
input
-- Returns:
- RestartDbcResponse
-
restartVw
public RestartVwResponse restartVw(RestartVwRequest input)
Restart a Virtual Warehouse.- Parameters:
input
-- Returns:
- RestartVwResponse
-
restoreBackup
public RestoreBackupResponse restoreBackup(RestoreBackupRequest input)
Restores backup.- Parameters:
input
-- Returns:
- RestoreBackupResponse
-
restoreCluster
public RestoreClusterResponse restoreCluster(RestoreClusterRequest input)
Restores the cluster from a backup data made by \"backup-cluster\" command.- Parameters:
input
-- Returns:
- RestoreClusterResponse
-
startVw
public StartVwResponse startVw(StartVwRequest input)
Starts a suspended Virtual Warehouse.- Parameters:
input
-- Returns:
- StartVwResponse
-
suspendDbc
public SuspendDbcResponse suspendDbc(SuspendDbcRequest input)
Suspends a running Database Catalog.- Parameters:
input
-- Returns:
- SuspendDbcResponse
-
suspendVw
public SuspendVwResponse suspendVw(SuspendVwRequest input)
Suspends a running Virtual Warehouse.- Parameters:
input
-- Returns:
- SuspendVwResponse
-
updateCluster
public UpdateClusterResponse updateCluster(UpdateClusterRequest input)
Updates the Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- UpdateClusterResponse
-
updateDataVisualization
public UpdateDataVisualizationResponse updateDataVisualization(UpdateDataVisualizationRequest input)
Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.- Parameters:
input
-- Returns:
- UpdateDataVisualizationResponse
-
updateDbc
public UpdateDbcResponse updateDbc(UpdateDbcRequest input)
Update the configuration of a Database Catalog.- Parameters:
input
-- Returns:
- UpdateDbcResponse
-
updateDbcConfig
public UpdateDbcConfigResponse updateDbcConfig(UpdateDbcConfigRequest input)
Update a Database Catalog configuration.- Parameters:
input
-- Returns:
- UpdateDbcConfigResponse
-
updateServerSetting
public UpdateServerSettingResponse updateServerSetting(UpdateServerSettingRequest input)
Update the DWX server settings.- Parameters:
input
-- Returns:
- UpdateServerSettingResponse
-
updateSshKey
public UpdateSshKeyResponse updateSshKey(UpdateSshKeyRequest input)
Update the SSH Key for a Cloudera Data Warehouse cluster- Parameters:
input
-- Returns:
- UpdateSshKeyResponse
-
updateVw
public UpdateVwResponse updateVw(UpdateVwRequest input)
Update the configuration of a Virtual Warehouse.- Parameters:
input
-- Returns:
- UpdateVwResponse
-
updateVwConfig
public UpdateVwConfigResponse updateVwConfig(UpdateVwConfigRequest input)
Update a Virtual Warehouse configuration.- Parameters:
input
-- Returns:
- UpdateVwConfigResponse
-
upgradeCluster
public UpgradeClusterResponse upgradeCluster(UpgradeClusterRequest input)
Upgrade the Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- UpgradeClusterResponse
-
upgradeDataVisualization
public UpgradeDataVisualizationResponse upgradeDataVisualization(UpgradeDataVisualizationRequest input)
Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.- Parameters:
input
-- Returns:
- UpgradeDataVisualizationResponse
-
upgradeDbc
public UpgradeDbcResponse upgradeDbc(UpgradeDbcRequest input)
Upgrades the Database Catalog to a compatible version.- Parameters:
input
-- Returns:
- UpgradeDbcResponse
-
upgradeVw
public UpgradeVwResponse upgradeVw(UpgradeVwRequest input)
Upgrades the Virtual Warehouse to a compatible version.- Parameters:
input
-- Returns:
- UpgradeVwResponse
-
-