Package com.cloudera.cdp.datahub.api
Class DatahubClient
java.lang.Object
com.cloudera.cdp.client.CdpClient
com.cloudera.cdp.datahub.api.DatahubClient
@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
date="2024-09-27T08:40:24.392-07:00")
public class DatahubClient
extends CdpClient
-
Field Summary
Fields inherited from class com.cloudera.cdp.client.CdpClient
NO_EXTENSION
-
Constructor Summary
ConstructorDescriptionDatahubClient
(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) DatahubClient
(CdpRequestContext<?> context) -
Method Summary
Modifier and TypeMethodDescriptionCancel running Datahub diagnostics collectionsStart Datahub Cloudera Manager based diagnostics collectionStart DataHub diagnostics collectionCreate Auto Scaling rules for a DataHub clusterCreates an AWS workload cluster.Creates an AWS Data Hub cluster for GovCloud.Creates an Azure workload cluster.Creates a cluster definition.Creates a cluster template.Creates custom configurations.Creates a GCP workload cluster.createRecipe
(CreateRecipeRequest input) Creates recipe.Delete AutoScaling policies for a DataHub clusterDeletes a workload cluster.Deletes cluster definitions.Deletes cluster templates.Deletes custom configurations.Deletes instances for the specified cluster.Deletes recipes.Describe the AutoScaling policies for a DataHub clusterDescribes a workload cluster.Describes a cluster definition.Describes a cluster template.Describes custom configurations.Describes recipe.Describes the Scaling Activity using Cluster CRN or Cluster NAME and operation ID.Get cluster host status.Get cluster service status.getCmRoles
(GetCmRolesRequest input) Gather Cloudera Manager roles that can be used for filtering in CM based diagnostics collection.Gather log descriptors that are used for diagnostics collection.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.getVmTypes
(GetVmTypesRequest input) Creates a recommendation that advises virtual machine types for the given cluster template based on the given properties.List AutoScale history activity for a DataHub cluster.Lists cluster definitions.Lists Workload cluster lifecycle events.listClusters
(ListClustersRequest input) Lists workload clusters.Lists cluster templates.Lists custom configurations.List recent Datahub diagnostics collectionslistRecipes
(ListRecipesRequest input) Lists recipes.Lists Scaling activities for a cluster.Running upgrade related validations and prepares the required parcels for the upgrade.Deprecated.Renews public certificate on a Datahub cluster by name or CRN.Repairs a cluster.Replaces recipes for the given instance groups.retryCluster
(RetryClusterRequest input) Retries creation of a failed workload cluster.Deprecated.Rotates database ssl certificate for a specific Data HubRotates private certificates on the hosts of Datahub.Rotate SaltStack user password on Data Hub instances.scaleCluster
(ScaleClusterRequest input) Scales a cluster by adding or removing cluster nodes.setCatalog
(SetCatalogRequest input) Sets a catalog for a DataHub.startCluster
(StartClusterRequest input) Starts a stopped workload cluster.Initiates the vertical scaling on Data Hub cluster.Upgrades the database of the Data Hub cluster.Starts instances of a particular host group in the Data Hub cluster.stopCluster
(StopClusterRequest input) Stops a workload cluster.Stops instances of particular host group in the Data Hub cluster.syncCluster
(SyncClusterRequest input) Synchronizes the state of a cluster with the cloud provider and Cloudera Manager.Syncs component versions from CM after a failed upgrade.Modify AutoScaling for a DataHub clusterRun orchestrator engine state update on the Data Hub cluster.Updates Data Hub AWS cluster to use IMDSv1.Updates Data Hub AWS cluster to use IMDSv2.Upgrades the OS or data platform on a datahub cluster.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
-
DatahubClient
public DatahubClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) -
DatahubClient
-
-
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
-
cancelDatahubDiagnostics
public CancelDatahubDiagnosticsResponse cancelDatahubDiagnostics(CancelDatahubDiagnosticsRequest input) Cancel running Datahub diagnostics collections- Parameters:
input
-- Returns:
- CancelDatahubDiagnosticsResponse
-
collectCmDiagnostics
Start Datahub Cloudera Manager based diagnostics collection- Parameters:
input
-- Returns:
- CollectCmDiagnosticsResponse
-
collectDatahubDiagnostics
public CollectDatahubDiagnosticsResponse collectDatahubDiagnostics(CollectDatahubDiagnosticsRequest input) Start DataHub diagnostics collection- Parameters:
input
-- Returns:
- CollectDatahubDiagnosticsResponse
-
createAWSCluster
Creates an AWS workload cluster.- Parameters:
input
-- Returns:
- CreateAWSClusterResponse
-
createAWSGovCloudCluster
public CreateAWSGovCloudClusterResponse createAWSGovCloudCluster(CreateAWSGovCloudClusterRequest input) Creates an AWS Data Hub cluster for GovCloud.- Parameters:
input
-- Returns:
- CreateAWSGovCloudClusterResponse
-
createAutoScaleRules
Create Auto Scaling rules for a DataHub cluster- Parameters:
input
-- Returns:
- CreateAutoScaleRulesResponse
-
createAzureCluster
Creates an Azure workload cluster.- Parameters:
input
-- Returns:
- CreateAzureClusterResponse
-
createClusterDefinition
public CreateClusterDefinitionResponse createClusterDefinition(CreateClusterDefinitionRequest input) Creates a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.- Parameters:
input
-- Returns:
- CreateClusterDefinitionResponse
-
createClusterTemplate
Creates a cluster template. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.- Parameters:
input
-- Returns:
- CreateClusterTemplateResponse
-
createCustomConfigurations
public CreateCustomConfigurationsResponse createCustomConfigurations(CreateCustomConfigurationsRequest input) Creates custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or append properties to the corresponding cluster template while launching DataHub clusters.- Parameters:
input
-- Returns:
- CreateCustomConfigurationsResponse
-
createGCPCluster
Creates a GCP workload cluster.- Parameters:
input
-- Returns:
- CreateGCPClusterResponse
-
createRecipe
Creates recipe. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- CreateRecipeResponse
-
deleteAutoScaleRules
Delete AutoScaling policies for a DataHub cluster- Parameters:
input
-- Returns:
- DeleteAutoScaleRulesResponse
-
deleteCluster
Deletes a workload cluster.- Parameters:
input
-- Returns:
- DeleteClusterResponse
-
deleteClusterDefinitions
public DeleteClusterDefinitionsResponse deleteClusterDefinitions(DeleteClusterDefinitionsRequest input) Deletes cluster definitions. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.- Parameters:
input
-- Returns:
- DeleteClusterDefinitionsResponse
-
deleteClusterTemplates
Deletes cluster templates. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.- Parameters:
input
-- Returns:
- DeleteClusterTemplatesResponse
-
deleteCustomConfigurations
public DeleteCustomConfigurationsResponse deleteCustomConfigurations(DeleteCustomConfigurationsRequest input) Deletes custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or append properties to the corresponding cluster template while launching DataHub clusters.- Parameters:
input
-- Returns:
- DeleteCustomConfigurationsResponse
-
deleteInstances
Deletes instances for the specified cluster.- Parameters:
input
-- Returns:
- DeleteInstancesResponse
-
deleteRecipes
Deletes recipes. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- DeleteRecipesResponse
-
describeAutoScaleRules
Describe the AutoScaling policies for a DataHub cluster- Parameters:
input
-- Returns:
- DescribeAutoScaleRulesResponse
-
describeCluster
Describes a workload cluster.- Parameters:
input
-- Returns:
- DescribeClusterResponse
-
describeClusterDefinition
public DescribeClusterDefinitionResponse describeClusterDefinition(DescribeClusterDefinitionRequest input) Describes a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.- Parameters:
input
-- Returns:
- DescribeClusterDefinitionResponse
-
describeClusterTemplate
public DescribeClusterTemplateResponse describeClusterTemplate(DescribeClusterTemplateRequest input) Describes a cluster template. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.- Parameters:
input
-- Returns:
- DescribeClusterTemplateResponse
-
describeCustomConfigurations
public DescribeCustomConfigurationsResponse describeCustomConfigurations(DescribeCustomConfigurationsRequest input) Describes custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or append properties to the corresponding cluster template while launching DataHub clusters.- Parameters:
input
-- Returns:
- DescribeCustomConfigurationsResponse
-
describeRecipe
Describes recipe. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- DescribeRecipeResponse
-
describeScalingActivity
public DescribeScalingActivityResponse describeScalingActivity(DescribeScalingActivityRequest input) Describes the Scaling Activity using Cluster CRN or Cluster NAME and operation ID.- Parameters:
input
-- Returns:
- DescribeScalingActivityResponse
-
getClusterHostStatus
Get cluster host status.- Parameters:
input
-- Returns:
- GetClusterHostStatusResponse
-
getClusterServiceStatus
public GetClusterServiceStatusResponse getClusterServiceStatus(GetClusterServiceStatusRequest input) Get cluster service status.- Parameters:
input
-- Returns:
- GetClusterServiceStatusResponse
-
getCmRoles
Gather Cloudera Manager roles that can be used for filtering in CM based diagnostics collection.- Parameters:
input
-- Returns:
- GetCmRolesResponse
-
getDatahubLogDescriptors
public GetDatahubLogDescriptorsResponse getDatahubLogDescriptors(GetDatahubLogDescriptorsRequest input) Gather log descriptors that are used for diagnostics collection.- Parameters:
input
-- Returns:
- GetDatahubLogDescriptorsResponse
-
getVmTypes
Creates a recommendation that advises virtual machine types for the given cluster template based on the given properties.- Parameters:
input
-- Returns:
- GetVmTypesResponse
-
listAutoScaleHistory
List AutoScale history activity for a DataHub cluster.- Parameters:
input
-- Returns:
- ListAutoScaleHistoryResponse
-
listClusterDefinitions
Lists cluster definitions. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.- Parameters:
input
-- Returns:
- ListClusterDefinitionsResponse
-
listClusterLifecycleEvents
public ListClusterLifecycleEventsResponse listClusterLifecycleEvents(ListClusterLifecycleEventsRequest input) Lists Workload cluster lifecycle events.- Parameters:
input
-- Returns:
- ListClusterLifecycleEventsResponse
-
listClusterTemplates
Lists cluster templates. A cluster template is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical Cloudera Runtime settings.- Parameters:
input
-- Returns:
- ListClusterTemplatesResponse
-
listClusters
Lists workload clusters.- Parameters:
input
-- Returns:
- ListClustersResponse
-
listCustomConfigurations
public ListCustomConfigurationsResponse listCustomConfigurations(ListCustomConfigurationsRequest input) Lists custom configurations. Custom Configurations are sets of properties or name-value pairs that belong to any of the services present in cluster templates. These can be used to override and/or append properties to the corresponding cluster template while launching DataHub clusters.- Parameters:
input
-- Returns:
- ListCustomConfigurationsResponse
-
listDatahubDiagnostics
List recent Datahub diagnostics collections- Parameters:
input
-- Returns:
- ListDatahubDiagnosticsResponse
-
listRecipes
Lists recipes. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- ListRecipesResponse
-
listScalingActivities
Lists Scaling activities for a cluster.- Parameters:
input
-- Returns:
- ListScalingActivitiesResponse
-
prepareClusterUpgrade
Running upgrade related validations and prepares the required parcels for the upgrade.- Parameters:
input
-- Returns:
- PrepareClusterUpgradeResponse
-
renewCertificate
Deprecated.Renew certificate on datahub cluster by name or CRN- Parameters:
input
-- Returns:
- RenewCertificateResponse
-
renewPublicCertificate
Renews public certificate on a Datahub cluster by name or CRN.- Parameters:
input
-- Returns:
- RenewPublicCertificateResponse
-
repairCluster
Repairs a cluster.- Parameters:
input
-- Returns:
- RepairClusterResponse
-
replaceRecipes
Replaces recipes for the given instance groups.- Parameters:
input
-- Returns:
- ReplaceRecipesResponse
-
retryCluster
Retries creation of a failed workload cluster.- Parameters:
input
-- Returns:
- RetryClusterResponse
-
rotateAutoTlsCertificates
@Deprecated public RotateAutoTlsCertificatesResponse rotateAutoTlsCertificates(RotateAutoTlsCertificatesRequest input) Deprecated.Rotate autotls certificates on the datahub's hosts- Parameters:
input
-- Returns:
- RotateAutoTlsCertificatesResponse
-
rotateDbCertificate
Rotates database ssl certificate for a specific Data Hub- Parameters:
input
-- Returns:
- RotateDbCertificateResponse
-
rotatePrivateCertificates
public RotatePrivateCertificatesResponse rotatePrivateCertificates(RotatePrivateCertificatesRequest input) Rotates private certificates on the hosts of Datahub.- Parameters:
input
-- Returns:
- RotatePrivateCertificatesResponse
-
rotateSaltPassword
Rotate SaltStack user password on Data Hub instances.- Parameters:
input
-- Returns:
- RotateSaltPasswordResponse
-
scaleCluster
Scales a cluster by adding or removing cluster nodes.- Parameters:
input
-- Returns:
- ScaleClusterResponse
-
setCatalog
Sets a catalog for a DataHub.- Parameters:
input
-- Returns:
- SetCatalogResponse
-
startCluster
Starts a stopped workload cluster.- Parameters:
input
-- Returns:
- StartClusterResponse
-
startClusterVerticalScaling
public StartClusterVerticalScalingResponse startClusterVerticalScaling(StartClusterVerticalScalingRequest input) Initiates the vertical scaling on Data Hub cluster.- Parameters:
input
-- Returns:
- StartClusterVerticalScalingResponse
-
startDatabaseUpgrade
Upgrades the database of the Data Hub cluster.- Parameters:
input
-- Returns:
- StartDatabaseUpgradeResponse
-
startInstances
Starts instances of a particular host group in the Data Hub cluster.- Parameters:
input
-- Returns:
- StartInstancesResponse
-
stopCluster
Stops a workload cluster.- Parameters:
input
-- Returns:
- StopClusterResponse
-
stopInstances
Stops instances of particular host group in the Data Hub cluster.- Parameters:
input
-- Returns:
- StopInstancesResponse
-
syncCluster
Synchronizes the state of a cluster with the cloud provider and Cloudera Manager.- Parameters:
input
-- Returns:
- SyncClusterResponse
-
syncComponentVersionsFromCm
public SyncComponentVersionsFromCmResponse syncComponentVersionsFromCm(SyncComponentVersionsFromCmRequest input) Syncs component versions from CM after a failed upgrade.- Parameters:
input
-- Returns:
- SyncComponentVersionsFromCmResponse
-
updateAutoScaleRules
Modify AutoScaling for a DataHub cluster- Parameters:
input
-- Returns:
- UpdateAutoScaleRulesResponse
-
updateOrchestratorState
public UpdateOrchestratorStateResponse updateOrchestratorState(UpdateOrchestratorStateRequest input) Run orchestrator engine state update on the Data Hub cluster.- Parameters:
input
-- Returns:
- UpdateOrchestratorStateResponse
-
updateToAwsImdsV1
Updates Data Hub AWS cluster to use IMDSv1.- Parameters:
input
-- Returns:
- UpdateToAwsImdsV1Response
-
updateToAwsImdsV2
Updates Data Hub AWS cluster to use IMDSv2.- Parameters:
input
-- Returns:
- UpdateToAwsImdsV2Response
-
upgradeCluster
Upgrades the OS or data platform on a datahub cluster.- Parameters:
input
-- Returns:
- UpgradeClusterResponse
-