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="2022-08-18T19:29:50.369-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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddUserResponse
addUser(AddUserRequest input)
Adds the given user to the cluster.CreateClusterResponse
createCluster(CreateClusterRequest input)
Create a Cloudera Data Warehouse cluster.CreateDataVisualizationResponse
createDataVisualization(CreateDataVisualizationRequest input)
Creates a Cloudera Data Visualization.CreateDbcResponse
createDbc(CreateDbcRequest input)
Create a Database Catalog.CreateDbcDiagnosticDataJobResponse
createDbcDiagnosticDataJob(CreateDbcDiagnosticDataJobRequest input)
Create a diganostic data job for the given Database Catalog.CreateVwResponse
createVw(CreateVwRequest input)
Create a Virtual Warehouse.CreateVwDiagnosticDataJobResponse
createVwDiagnosticDataJob(CreateVwDiagnosticDataJobRequest input)
Create a diganostic data job for the given Virtual Warehouse.DeleteClusterResponse
deleteCluster(DeleteClusterRequest input)
Delete a Cloudera Data Warehouse cluster.DeleteDataVisualizationResponse
deleteDataVisualization(DeleteDataVisualizationRequest input)
Asynchronous operation that deletes a Cloudera Data Visualization.DeleteDbcResponse
deleteDbc(DeleteDbcRequest input)
Delete a Database Catalog.DeleteDbcDiagnosticDataJobResponse
deleteDbcDiagnosticDataJob(DeleteDbcDiagnosticDataJobRequest input)
Delete a diagnostic job for the given Database Catalog.DeleteUserResponse
deleteUser(DeleteUserRequest input)
Deletes the given user from the cluster.DeleteVwResponse
deleteVw(DeleteVwRequest input)
Delete a Virtual Warehouse.DeleteVwDiagnosticDataJobResponse
deleteVwDiagnosticDataJob(DeleteVwDiagnosticDataJobRequest input)
Delete a diagnostic job for the given Virtual Warehouse.DescribeClusterResponse
describeCluster(DescribeClusterRequest input)
Describe a Cloudera Data Warehouse cluster.DescribeConfigResponse
describeConfig(DescribeConfigRequest input)
Describe a service configuration.DescribeConfigDiffResponse
describeConfigDiff(DescribeConfigDiffRequest input)
Get differences between two service configurations.DescribeDataVisualizationResponse
describeDataVisualization(DescribeDataVisualizationRequest input)
Describes a Cloudera Data Visualization.DescribeDbcResponse
describeDbc(DescribeDbcRequest input)
Describe a Database Catalog.DescribeDbcDiagnosticDataJobResponse
describeDbcDiagnosticDataJob(DescribeDbcDiagnosticDataJobRequest input)
Describe a diagnostic job for the given Database Catalog.DescribeKubeconfigResponse
describeKubeconfig(DescribeKubeconfigRequest input)
Get Kubeconfig for a Cloudera Data Warehouse cluster.DescribeVwResponse
describeVw(DescribeVwRequest input)
Describe a Virtual Warehouse.DescribeVwDiagnosticDataJobResponse
describeVwDiagnosticDataJob(DescribeVwDiagnosticDataJobRequest input)
Describe a diagnostic jobs for the given Virtual Warehouse.GetDataVisualizationUpgradeVersionResponse
getDataVisualizationUpgradeVersion(GetDataVisualizationUpgradeVersionRequest input)
Gets latest version and latest compatible version for Cloudera Data Visualization.protected String
getRequestContentType()
Gets the request Content-Type, used by 'Conent-Type' request header.protected String
getResponseContentType()
Gets the expected response Content-Type, used by 'Accept' request header.protected String
getServiceName()
Gets the service name.GetUpgradeDbcVersionsResponse
getUpgradeDbcVersions(GetUpgradeDbcVersionsRequest input)
Gets the latest version and latest compatible version for Database Catalog.GetUpgradeVwVersionsResponse
getUpgradeVwVersions(GetUpgradeVwVersionsRequest input)
Gets the latest version and latest compatible version for Virtual Warehouse.HealthCheckResponse
healthCheck(HealthCheckRequest input)
Check the health of the API.ListClustersResponse
listClusters(ListClustersRequest input)
List Cloudera Data Warehouse clusters.ListDataVisualizationsResponse
listDataVisualizations(ListDataVisualizationsRequest input)
Lists Cloudera Data Visualization in the provided CDW cluster.ListDbcConfigsResponse
listDbcConfigs(ListDbcConfigsRequest input)
Get the configuration history of a Database Catalog.ListDbcDiagnosticDataJobsResponse
listDbcDiagnosticDataJobs(ListDbcDiagnosticDataJobsRequest input)
Get the list of diagnostic jobs for the given Database Catalog.ListDbcsResponse
listDbcs(ListDbcsRequest input)
List Database Catalogs.ListLatestVersionsResponse
listLatestVersions(ListLatestVersionsRequest input)
Lists the latest version of the product (if available) for all catalogs in the environment.ListUsersResponse
listUsers(ListUsersRequest input)
Lists the users who have access to the cluster.ListVwConfigsResponse
listVwConfigs(ListVwConfigsRequest input)
Get the configuration history of a Virtual Warehouse.ListVwDiagnosticDataJobsResponse
listVwDiagnosticDataJobs(ListVwDiagnosticDataJobsRequest input)
Get the list of diagnostic jobs for the given Virtual Warehouse.ListVwsResponse
listVws(ListVwsRequest input)
List Virtual Warehouses.PauseVwResponse
pauseVw(PauseVwRequest input)
Pauses a running Virtual Warehouse.RenewCertificatesResponse
renewCertificates(RenewCertificatesRequest input)
Renew certificates for a Cloudera Data Warehouse Azure cluster.RestartDbcResponse
restartDbc(RestartDbcRequest input)
Restart a Database Catalog.RestartVwResponse
restartVw(RestartVwRequest input)
Restart a Virtual Warehouse.StartVwResponse
startVw(StartVwRequest input)
Starts a paused Virtual Warehouse.UpdateClusterResponse
updateCluster(UpdateClusterRequest input)
Updates the Cloudera Data Warehouse cluster.UpdateDataVisualizationResponse
updateDataVisualization(UpdateDataVisualizationRequest input)
Asynchronous operation that updates the configuration of a Cloudera Data Visualization.UpdateDbcResponse
updateDbc(UpdateDbcRequest input)
Update the configuration of a Database Catalog.UpdateSshKeyResponse
updateSshKey(UpdateSshKeyRequest input)
Update the SSH Key for a Cloudera Data Warehouse clusterUpdateVwResponse
updateVw(UpdateVwRequest input)
Update the configuration of a Virtual Warehouse.UpgradeDataVisualizationResponse
upgradeDataVisualization(UpgradeDataVisualizationRequest input)
Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version.UpgradeDbcResponse
upgradeDbc(UpgradeDbcRequest input)
Upgrades the Database Catalog to a compatible version.UpgradeVwResponse
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 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
-
createCluster
public CreateClusterResponse createCluster(CreateClusterRequest input)
Create a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- CreateClusterResponse
-
createDataVisualization
public CreateDataVisualizationResponse createDataVisualization(CreateDataVisualizationRequest input)
Creates a Cloudera Data Visualization.- Parameters:
input
-- Returns:
- CreateDataVisualizationResponse
-
createDbc
public CreateDbcResponse createDbc(CreateDbcRequest input)
Create a Database Catalog.- Parameters:
input
-- Returns:
- CreateDbcResponse
-
createDbcDiagnosticDataJob
public CreateDbcDiagnosticDataJobResponse createDbcDiagnosticDataJob(CreateDbcDiagnosticDataJobRequest input)
Create a diganostic data 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 diganostic data job for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- CreateVwDiagnosticDataJobResponse
-
deleteCluster
public DeleteClusterResponse deleteCluster(DeleteClusterRequest input)
Delete a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DeleteClusterResponse
-
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)
Delete 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
-
describeCluster
public DescribeClusterResponse describeCluster(DescribeClusterRequest input)
Describe a Cloudera Data Warehouse cluster.- Parameters:
input
-- Returns:
- DescribeClusterResponse
-
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
-
describeDbcDiagnosticDataJob
public DescribeDbcDiagnosticDataJobResponse describeDbcDiagnosticDataJob(DescribeDbcDiagnosticDataJobRequest input)
Describe 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
-
describeVw
public DescribeVwResponse describeVw(DescribeVwRequest input)
Describe a Virtual Warehouse.- Parameters:
input
-- Returns:
- DescribeVwResponse
-
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
-
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
-
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 the list of diagnostic jobs for the given Database Catalog.- Parameters:
input
-- Returns:
- ListDbcDiagnosticDataJobsResponse
-
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
-
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 the list of diagnostic jobs for the given Virtual Warehouse.- Parameters:
input
-- Returns:
- ListVwDiagnosticDataJobsResponse
-
listVws
public ListVwsResponse listVws(ListVwsRequest input)
List Virtual Warehouses.- Parameters:
input
-- Returns:
- ListVwsResponse
-
pauseVw
public PauseVwResponse pauseVw(PauseVwRequest input)
Pauses a running Virtual Warehouse.- Parameters:
input
-- Returns:
- PauseVwResponse
-
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
-
startVw
public StartVwResponse startVw(StartVwRequest input)
Starts a paused Virtual Warehouse.- Parameters:
input
-- Returns:
- StartVwResponse
-
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
-
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
-
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
-
-