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="2023-09-27T13:27:50.892-07:00") public class DatahubClient 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 DatahubClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
DatahubClient(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
-
DatahubClient
public DatahubClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
-
DatahubClient
public DatahubClient(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
-
cancelDatahubDiagnostics
public CancelDatahubDiagnosticsResponse cancelDatahubDiagnostics(CancelDatahubDiagnosticsRequest input)
Cancel running Datahub diagnostics collections- Parameters:
input
-- Returns:
- CancelDatahubDiagnosticsResponse
-
collectCmDiagnostics
public CollectCmDiagnosticsResponse collectCmDiagnostics(CollectCmDiagnosticsRequest input)
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
public CreateAWSClusterResponse createAWSCluster(CreateAWSClusterRequest input)
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
public CreateAutoScaleRulesResponse createAutoScaleRules(CreateAutoScaleRulesRequest input)
Create Auto Scaling rules for a DataHub cluster- Parameters:
input
-- Returns:
- CreateAutoScaleRulesResponse
-
createAzureCluster
public CreateAzureClusterResponse createAzureCluster(CreateAzureClusterRequest input)
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
public CreateClusterTemplateResponse createClusterTemplate(CreateClusterTemplateRequest input)
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
public CreateGCPClusterResponse createGCPCluster(CreateGCPClusterRequest input)
Creates a GCP workload cluster.- Parameters:
input
-- Returns:
- CreateGCPClusterResponse
-
createRecipe
public CreateRecipeResponse createRecipe(CreateRecipeRequest input)
Creates recipe. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- CreateRecipeResponse
-
deleteAutoScaleRules
public DeleteAutoScaleRulesResponse deleteAutoScaleRules(DeleteAutoScaleRulesRequest input)
Delete AutoScaling policies for a DataHub cluster- Parameters:
input
-- Returns:
- DeleteAutoScaleRulesResponse
-
deleteCluster
public DeleteClusterResponse deleteCluster(DeleteClusterRequest input)
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
public DeleteClusterTemplatesResponse deleteClusterTemplates(DeleteClusterTemplatesRequest input)
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
public DeleteInstancesResponse deleteInstances(DeleteInstancesRequest input)
Deletes instances for the specified cluster.- Parameters:
input
-- Returns:
- DeleteInstancesResponse
-
deleteRecipes
public DeleteRecipesResponse deleteRecipes(DeleteRecipesRequest input)
Deletes recipes. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- DeleteRecipesResponse
-
describeAutoScaleRules
public DescribeAutoScaleRulesResponse describeAutoScaleRules(DescribeAutoScaleRulesRequest input)
Describe the AutoScaling policies for a DataHub cluster- Parameters:
input
-- Returns:
- DescribeAutoScaleRulesResponse
-
describeCluster
public DescribeClusterResponse describeCluster(DescribeClusterRequest input)
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
public DescribeRecipeResponse describeRecipe(DescribeRecipeRequest input)
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
public GetClusterHostStatusResponse getClusterHostStatus(GetClusterHostStatusRequest input)
Get cluster host status.- Parameters:
input
-- Returns:
- GetClusterHostStatusResponse
-
getClusterServiceStatus
public GetClusterServiceStatusResponse getClusterServiceStatus(GetClusterServiceStatusRequest input)
Get cluster service status.- Parameters:
input
-- Returns:
- GetClusterServiceStatusResponse
-
getCmRoles
public GetCmRolesResponse getCmRoles(GetCmRolesRequest input)
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
-
listAutoScaleHistory
public ListAutoScaleHistoryResponse listAutoScaleHistory(ListAutoScaleHistoryRequest input)
List AutoScale history activity for a DataHub cluster.- Parameters:
input
-- Returns:
- ListAutoScaleHistoryResponse
-
listClusterDefinitions
public ListClusterDefinitionsResponse listClusterDefinitions(ListClusterDefinitionsRequest input)
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
public ListClusterTemplatesResponse listClusterTemplates(ListClusterTemplatesRequest input)
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
public ListClustersResponse listClusters(ListClustersRequest input)
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
public ListDatahubDiagnosticsResponse listDatahubDiagnostics(ListDatahubDiagnosticsRequest input)
List recent Datahub diagnostics collections- Parameters:
input
-- Returns:
- ListDatahubDiagnosticsResponse
-
listRecipes
public ListRecipesResponse listRecipes(ListRecipesRequest input)
Lists recipes. A recipe is a script that runs on all nodes of a specified instance group.- Parameters:
input
-- Returns:
- ListRecipesResponse
-
listScalingActivities
public ListScalingActivitiesResponse listScalingActivities(ListScalingActivitiesRequest input)
Lists Scaling activities for a cluster.- Parameters:
input
-- Returns:
- ListScalingActivitiesResponse
-
prepareClusterUpgrade
public PrepareClusterUpgradeResponse prepareClusterUpgrade(PrepareClusterUpgradeRequest input)
Running upgrade related validations and prepares the required parcels for the upgrade.- Parameters:
input
-- Returns:
- PrepareClusterUpgradeResponse
-
renewCertificate
@Deprecated public RenewCertificateResponse renewCertificate(RenewCertificateRequest input)
Deprecated.Renew certificate on datahub cluster by name or CRN- Parameters:
input
-- Returns:
- RenewCertificateResponse
-
renewPublicCertificate
public RenewPublicCertificateResponse renewPublicCertificate(RenewPublicCertificateRequest input)
Renews public certificate on a Datahub cluster by name or CRN.- Parameters:
input
-- Returns:
- RenewPublicCertificateResponse
-
repairCluster
public RepairClusterResponse repairCluster(RepairClusterRequest input)
Repairs a cluster.- Parameters:
input
-- Returns:
- RepairClusterResponse
-
replaceRecipes
public ReplaceRecipesResponse replaceRecipes(ReplaceRecipesRequest input)
Replaces recipes for the given instance groups.- Parameters:
input
-- Returns:
- ReplaceRecipesResponse
-
retryCluster
public RetryClusterResponse retryCluster(RetryClusterRequest input)
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
-
rotatePrivateCertificates
public RotatePrivateCertificatesResponse rotatePrivateCertificates(RotatePrivateCertificatesRequest input)
Rotates private certificates on the hosts of Datahub.- Parameters:
input
-- Returns:
- RotatePrivateCertificatesResponse
-
rotateSaltPassword
public RotateSaltPasswordResponse rotateSaltPassword(RotateSaltPasswordRequest input)
Rotate SaltStack user password on Data Hub instances.- Parameters:
input
-- Returns:
- RotateSaltPasswordResponse
-
scaleCluster
public ScaleClusterResponse scaleCluster(ScaleClusterRequest input)
Scales a cluster by adding or removing cluster nodes.- Parameters:
input
-- Returns:
- ScaleClusterResponse
-
setCatalog
public SetCatalogResponse setCatalog(SetCatalogRequest input)
Sets a catalog for a DataHub.- Parameters:
input
-- Returns:
- SetCatalogResponse
-
startCluster
public StartClusterResponse startCluster(StartClusterRequest input)
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
public StartDatabaseUpgradeResponse startDatabaseUpgrade(StartDatabaseUpgradeRequest input)
Upgrades the database of the Data Hub cluster.- Parameters:
input
-- Returns:
- StartDatabaseUpgradeResponse
-
startInstances
public StartInstancesResponse startInstances(StartInstancesRequest input)
Starts instances of a particular host group in the Data Hub cluster.- Parameters:
input
-- Returns:
- StartInstancesResponse
-
stopCluster
public StopClusterResponse stopCluster(StopClusterRequest input)
Stops a workload cluster.- Parameters:
input
-- Returns:
- StopClusterResponse
-
stopInstances
public StopInstancesResponse stopInstances(StopInstancesRequest input)
Stops instances of particular host group in the Data Hub cluster.- Parameters:
input
-- Returns:
- StopInstancesResponse
-
syncCluster
public SyncClusterResponse syncCluster(SyncClusterRequest input)
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
public UpdateAutoScaleRulesResponse updateAutoScaleRules(UpdateAutoScaleRulesRequest input)
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
-
upgradeCluster
public UpgradeClusterResponse upgradeCluster(UpgradeClusterRequest input)
Upgrades the OS or data platform on a datahub cluster.- Parameters:
input
-- Returns:
- UpgradeClusterResponse
-
-