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="2024-09-27T08:40:25.071-07:00")
public class DwClient
extends CdpClient
-
Field Summary
Fields inherited from class com.cloudera.cdp.client.CdpClient
NO_EXTENSION
-
Constructor Summary
ConstructorDescriptionDwClient
(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) DwClient
(CdpRequestContext<?> context) -
Method Summary
Modifier and TypeMethodDescriptionaddUser
(AddUserRequest input) Adds the given user to the cluster.Creates a backup from the cluster configuration and settings.Create an AWS cluster in the Cloudera Data Warehouse.Create an Azure cluster in the Cloudera Data Warehouse.createBackup
(CreateBackupRequest input) Creates a backup for the data warehouse.Create a Cloudera Data Warehouse cluster.Create a diagnostic job for the given cluster.Creates a Cloudera Data Visualization.createDbc
(CreateDbcRequest input) Deprecated.Create a diagnostic job for the given database catalog.Create a a Private Cloud cluster in the Cloudera Data Warehouse.Create a resource allocation template.createVw
(CreateVwRequest input) Create a Virtual Warehouse.Create a diagnostic job for the given Virtual Warehouse.deleteBackup
(DeleteBackupRequest input) Deletes a data warehouse backup.Delete a Cloudera Data Warehouse cluster.Deletes a diagnostic job for the given cluster.Asynchronous operation that deletes a Cloudera Data Visualization.deleteDbc
(DeleteDbcRequest input) Delete a Database Catalog.Deletes a diagnostic job for the given Database Catalog.Delete a resource allocation template.deleteUser
(DeleteUserRequest input) Deletes the given user from the cluster.deleteVw
(DeleteVwRequest input) Delete a Virtual Warehouse.Delete a diagnostic job for the given Virtual Warehouse.Get allowed compute instance types for both AWS and Azure cluster types and their default values.Describes the backup.Describe a Cloudera Data Warehouse cluster.Describes a diagnostic job for the given Cluster.Describe a service configuration.Get differences between two service configurations.Describes a Cloudera Data Visualization.describeDbc
(DescribeDbcRequest input) Describe a Database Catalog.Describes the Database Catalog current configuration.Describes a diagnostic job for the given Database Catalog.Get Kubeconfig for a Cloudera Data Warehouse cluster.Describes the restore.Get the DWX server settings.describeVw
(DescribeVwRequest input) Describe a Virtual Warehouse.Describes the current configuration of a Hive or Impala Virtual Warehouse.Describe a diagnostic jobs for the given Virtual Warehouse.Gets latest version and latest compatible version for Cloudera Data Visualization.getLogs
(GetLogsRequest input) Gets job logs.protected String
Gets the request Content-Type, used by 'Conent-Type' request header.protected String
Gets the expected response Content-Type, used by 'Accept' request header.protected String
Gets the service name.Gets the latest version and latest compatible version for Database Catalog.Gets the latest version and latest compatible version for Virtual Warehouse.healthCheck
(HealthCheckRequest input) Check the health of the API.Lists potential backup entities associated with the data warehouse.listBackups
(ListBackupsRequest input) Lists backups.Get a list of diagnostic jobs for the given cluster.listClusters
(ListClustersRequest input) List Cloudera Data Warehouse clusters.Lists Cloudera Data Visualization in the provided CDW cluster.Get the configuration history of a Database Catalog.Get a list of diagnostic jobs for the given Database Catalog.Get the list of events for the given Database Catalog.listDbcs
(ListDbcsRequest input) List Database Catalogs.listEvents
(ListEventsRequest input) Get the list of events.Lists the latest version of the product (if available) for all catalogs in the environment.Get default resource allocation templates.listRestores
(ListRestoresRequest input) Lists restores.listUsers
(ListUsersRequest input) Lists the users who have access to the cluster.Get the configuration history of a Virtual Warehouse.Get a list of diagnostic jobs for the given Virtual Warehouse.listVwEvents
(ListVwEventsRequest input) Get the list of events for the given Virtual Warehouse.listVws
(ListVwsRequest input) List Virtual Warehouses.rebuildDbc
(RebuildDbcRequest input) Rebuild a Database Catalog.rebuildVw
(RebuildVwRequest input) Rebuild a Virtual Warehouse.Renew certificates for a Cloudera Data Warehouse Azure cluster.restartDbc
(RestartDbcRequest input) Restart a Database Catalog.restartVw
(RestartVwRequest input) Restart a Virtual Warehouse.Restores backup.Restores the cluster from a backup data made by \"backup-cluster\" command.startVw
(StartVwRequest input) Starts a suspended Virtual Warehouse.suspendDbc
(SuspendDbcRequest input) Suspends a running Database Catalog.suspendVw
(SuspendVwRequest input) Suspends a running Virtual Warehouse.Updates the Cloudera Data Warehouse cluster.Asynchronous operation that updates the configuration of a Cloudera Data Visualization.updateDbc
(UpdateDbcRequest input) Update the configuration of a Database Catalog.Update a Database Catalog configuration.Update a resource allocation template.Update the DWX server settings.updateSshKey
(UpdateSshKeyRequest input) Update the SSH Key for a Cloudera Data Warehouse clusterupdateVw
(UpdateVwRequest input) Update the configuration of a Virtual Warehouse.Update a Virtual Warehouse configuration.Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version.upgradeDbc
(UpgradeDbcRequest input) Upgrades the Database Catalog to a compatible version.upgradeVw
(UpgradeVwRequest input) Upgrades the Virtual Warehouse to a compatible version.Methods inherited from class com.cloudera.cdp.client.CdpClient
invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown
-
Field Details
-
SERVICE_NAME
- See Also:
-
-
Constructor Details
-
DwClient
public DwClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) -
DwClient
-
-
Method Details
-
getServiceName
Description copied from class:CdpClient
Gets the service name.- Specified by:
getServiceName
in classCdpClient
- Returns:
- the service name
-
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
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
Adds the given user to the cluster.- Parameters:
input
-- Returns:
- AddUserResponse
-
backupCluster
Creates a backup from the cluster configuration and settings.- Parameters:
input
-- Returns:
- BackupClusterResponse
-
createAwsCluster
Create an AWS cluster in the Cloudera Data Warehouse.- Parameters:
input
-- Returns:
- CreateAwsClusterResponse
-
createAzureCluster
Create an Azure cluster in the Cloudera Data Warehouse.- Parameters:
input
-- Returns:
- CreateAzureClusterResponse
-
createBackup
Creates a backup for the data warehouse.- Parameters:
input
-- Returns:
- CreateBackupResponse
-
createCluster
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.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
-
createPrivateCluster
Create a a Private Cloud cluster in the Cloudera Data Warehouse.- Parameters:
input
-- Returns:
- CreatePrivateClusterResponse
-
createResourceTemplate
Create a resource allocation template.- Parameters:
input
-- Returns:
- CreateResourceTemplateResponse
-
createVw
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
Deletes a data warehouse backup.- Parameters:
input
-- Returns:
- DeleteBackupResponse
-
deleteCluster
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
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
-
deleteResourceTemplate
Delete a resource allocation template.- Parameters:
input
-- Returns:
- DeleteResourceTemplateResponse
-
deleteUser
Deletes the given user from the cluster.- Parameters:
input
-- Returns:
- DeleteUserResponse
-
deleteVw
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
Describes the backup.- Parameters:
input
-- Returns:
- DescribeBackupResponse
-
describeCluster
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
Describe a service configuration.- Parameters:
input
-- Returns:
- DescribeConfigResponse
-
describeConfigDiff
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
Describe a Database Catalog.- Parameters:
input
-- Returns:
- DescribeDbcResponse
-
describeDbcConfig
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
Get Kubeconfig for a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DescribeKubeconfigResponse
-
describeRestore
Describes the restore.- Parameters:
input
-- Returns:
- DescribeRestoreResponse
-
describeServerSetting
Get the DWX server settings.- Parameters:
input
-- Returns:
- DescribeServerSettingResponse
-
describeVw
Describe a Virtual Warehouse.- Parameters:
input
-- Returns:
- DescribeVwResponse
-
describeVwConfig
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
Gets job logs.- Parameters:
input
-- Returns:
- GetLogsResponse
-
getUpgradeDbcVersions
Gets the latest version and latest compatible version for Database Catalog.- Parameters:
input
-- Returns:
- GetUpgradeDbcVersionsResponse
-
getUpgradeVwVersions
Gets the latest version and latest compatible version for Virtual Warehouse.- Parameters:
input
-- Returns:
- GetUpgradeVwVersionsResponse
-
healthCheck
Check the health of the API.- Parameters:
input
-- Returns:
- HealthCheckResponse
-
listBackupEntities
Lists potential backup entities associated with the data warehouse.- Parameters:
input
-- Returns:
- ListBackupEntitiesResponse
-
listBackups
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
List Cloudera Data Warehouse clusters.- Parameters:
input
-- Returns:
- ListClustersResponse
-
listDataVisualizations
Lists Cloudera Data Visualization in the provided CDW cluster.- Parameters:
input
-- Returns:
- ListDataVisualizationsResponse
-
listDbcConfigs
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
Get the list of events for the given Database Catalog.- Parameters:
input
-- Returns:
- ListDbcEventsResponse
-
listDbcs
List Database Catalogs.- Parameters:
input
-- Returns:
- ListDbcsResponse
-
listEvents
Get the list of events.- Parameters:
input
-- Returns:
- ListEventsResponse
-
listLatestVersions
Lists the latest version of the product (if available) for all catalogs in the environment.- Parameters:
input
-- Returns:
- ListLatestVersionsResponse
-
listResourceTemplates
Get default resource allocation templates.- Parameters:
input
-- Returns:
- ListResourceTemplatesResponse
-
listRestores
Lists restores.- Parameters:
input
-- Returns:
- ListRestoresResponse
-
listUsers
Lists the users who have access to the cluster.- Parameters:
input
-- Returns:
- ListUsersResponse
-
listVwConfigs
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
Get the list of events for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- ListVwEventsResponse
-
listVws
List Virtual Warehouses.- Parameters:
input
-- Returns:
- ListVwsResponse
-
rebuildDbc
Rebuild a Database Catalog.- Parameters:
input
-- Returns:
- RebuildDbcResponse
-
rebuildVw
Rebuild a Virtual Warehouse.- Parameters:
input
-- Returns:
- RebuildVwResponse
-
renewCertificates
Renew certificates for a Cloudera Data Warehouse Azure cluster.- Parameters:
input
-- Returns:
- RenewCertificatesResponse
-
restartDbc
Restart a Database Catalog.- Parameters:
input
-- Returns:
- RestartDbcResponse
-
restartVw
Restart a Virtual Warehouse.- Parameters:
input
-- Returns:
- RestartVwResponse
-
restoreBackup
Restores backup.- Parameters:
input
-- Returns:
- RestoreBackupResponse
-
restoreCluster
Restores the cluster from a backup data made by \"backup-cluster\" command.- Parameters:
input
-- Returns:
- RestoreClusterResponse
-
startVw
Starts a suspended Virtual Warehouse.- Parameters:
input
-- Returns:
- StartVwResponse
-
suspendDbc
Suspends a running Database Catalog.- Parameters:
input
-- Returns:
- SuspendDbcResponse
-
suspendVw
Suspends a running Virtual Warehouse.- Parameters:
input
-- Returns:
- SuspendVwResponse
-
updateCluster
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
Update the configuration of a Database Catalog.- Parameters:
input
-- Returns:
- UpdateDbcResponse
-
updateDbcConfig
Update a Database Catalog configuration.- Parameters:
input
-- Returns:
- UpdateDbcConfigResponse
-
updateResourceTemplate
Update a resource allocation template.- Parameters:
input
-- Returns:
- UpdateResourceTemplateResponse
-
updateServerSetting
Update the DWX server settings.- Parameters:
input
-- Returns:
- UpdateServerSettingResponse
-
updateSshKey
Update the SSH Key for a Cloudera Data Warehouse cluster- Parameters:
input
-- Returns:
- UpdateSshKeyResponse
-
updateVw
Update the configuration of a Virtual Warehouse.- Parameters:
input
-- Returns:
- UpdateVwResponse
-
updateVwConfig
Update a Virtual Warehouse configuration.- Parameters:
input
-- Returns:
- UpdateVwConfigResponse
-
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
Upgrades the Database Catalog to a compatible version.- Parameters:
input
-- Returns:
- UpgradeDbcResponse
-
upgradeVw
Upgrades the Virtual Warehouse to a compatible version.- Parameters:
input
-- Returns:
- UpgradeVwResponse
-