java.lang.Object
- com.cloudera.cdp.client.CdpClient
- - com.cloudera.cdp.datalake.api.DatalakeClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2023-12-01T13:59:40.843-08:00")
public class DatalakeClient
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
`DatalakeClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)`
`DatalakeClient(CdpRequestContext<?> context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`BackupDatalakeResponse`	`backupDatalake(BackupDatalakeRequest input)`	Create backup of datalake.
`BackupDatalakeStatusResponse`	`backupDatalakeStatus(BackupDatalakeStatusRequest input)`	Check the status of a datalake backup operation performed.
`CancelBackupResponse`	`cancelBackup(CancelBackupRequest input)`	Cancels the specified ongoing backup operation.
`CancelDatalakeDiagnosticsResponse`	`cancelDatalakeDiagnostics(CancelDatalakeDiagnosticsRequest input)`	Cancel running Datalake diagnostics collections
`CollectCmDiagnosticsResponse`	`collectCmDiagnostics(CollectCmDiagnosticsRequest input)`	Start DataLake Cloudera Manager based diagnostics collection
`CollectDatalakeDiagnosticsResponse`	`collectDatalakeDiagnostics(CollectDatalakeDiagnosticsRequest input)`	Start DataLake diagnostics collection
`CreateAWSDatalakeResponse`	`createAWSDatalake(CreateAWSDatalakeRequest input)`	Creates an AWS datalake.
`CreateAWSGovCloudDatalakeResponse`	`createAWSGovCloudDatalake(CreateAWSGovCloudDatalakeRequest input)`	Creates a Data Lake on AWS GovCloud.
`CreateAzureDatalakeResponse`	`createAzureDatalake(CreateAzureDatalakeRequest input)`	Creates an Azure datalake.
`CreateGCPDatalakeResponse`	`createGCPDatalake(CreateGCPDatalakeRequest input)`	Creates an GCP Data Lake.
`DeleteDatalakeResponse`	`deleteDatalake(DeleteDatalakeRequest input)`	Deletes a datalake.
`DescribeDatabaseServerResponse`	`describeDatabaseServer(DescribeDatabaseServerRequest input)`	Gets external database server details.
`DescribeDatalakeResponse`	`describeDatalake(DescribeDatalakeRequest input)`	Describes a datalake.
`GetClusterHostStatusResponse`	`getClusterHostStatus(GetClusterHostStatusRequest input)`	Get cluster host status.
`GetClusterServiceStatusResponse`	`getClusterServiceStatus(GetClusterServiceStatusRequest input)`	Get cluster service status.
`GetCmRolesResponse`	`getCmRoles(GetCmRolesRequest input)`	Gather Cloudera Manager roles that can be used for filtering in CM based diagnostics collection.
`GetDatalakeLogDescriptorsResponse`	`getDatalakeLogDescriptors(GetDatalakeLogDescriptorsRequest input)`	Gather log descriptors that are used for diagnostics collection.
`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.
`ListDatalakeBackupsResponse`	`listDatalakeBackups(ListDatalakeBackupsRequest input)`	List all the backup operations that were performed on the datalake.
`ListDatalakeDiagnosticsResponse`	`listDatalakeDiagnostics(ListDatalakeDiagnosticsRequest input)`	List recent Datalake diagnostics collections
`ListDatalakesResponse`	`listDatalakes(ListDatalakesRequest input)`	Lists datalakes.
`ListRuntimesResponse`	`listRuntimes(ListRuntimesRequest input)`	Lists the datalake versions.
`PrepareDatalakeUpgradeResponse`	`prepareDatalakeUpgrade(PrepareDatalakeUpgradeRequest input)`	Prepares the Data Lake cluster for upgrade.
`RecoverDatalakeResponse`	`recoverDatalake(RecoverDatalakeRequest input)`	Recover data lake to the original version after a failed upgrade.
`RenewCertificateResponse`	`renewCertificate(RenewCertificateRequest input)`	Deprecated.
`RenewPublicCertificateResponse`	`renewPublicCertificate(RenewPublicCertificateRequest input)`	Renews public certificate on Datalake cluster by name or CRN.
`RepairDatalakeResponse`	`repairDatalake(RepairDatalakeRequest input)`	Repairs a datalake.
`ReplaceRecipesResponse`	`replaceRecipes(ReplaceRecipesRequest input)`	Replaces recipes for the given instance groups.
`ResizeDatalakeResponse`	`resizeDatalake(ResizeDatalakeRequest input)`	Resizes the given datalake to the given target size.
`RestoreDatalakeResponse`	`restoreDatalake(RestoreDatalakeRequest input)`	Restore the datalake from backup taken.
`RestoreDatalakeStatusResponse`	`restoreDatalakeStatus(RestoreDatalakeStatusRequest input)`	Check the status of datalake restore operation.
`RetryDatalakeResponse`	`retryDatalake(RetryDatalakeRequest input)`	Retry last failed operation on a datalake.
`RotateAutoTlsCertificatesResponse`	`rotateAutoTlsCertificates(RotateAutoTlsCertificatesRequest input)`	Deprecated.
`RotatePrivateCertificatesResponse`	`rotatePrivateCertificates(RotatePrivateCertificatesRequest input)`	Rotates private certificates on the datalake's hosts.
`RotateSaltPasswordResponse`	`rotateSaltPassword(RotateSaltPasswordRequest input)`	Rotate SaltStack user password on DataLake instances.
`SetCatalogResponse`	`setCatalog(SetCatalogRequest input)`	Sets a catalog for a DataLake.
`StartDatabaseUpgradeResponse`	`startDatabaseUpgrade(StartDatabaseUpgradeRequest input)`	Upgrades the database of the Data Lake cluster.
`StartDatalakeResponse`	`startDatalake(StartDatalakeRequest input)`	Deprecated.
`StartDatalakeVerticalScalingResponse`	`startDatalakeVerticalScaling(StartDatalakeVerticalScalingRequest input)`	Initiates the vertical scaling on Data Lake.
`StopDatalakeResponse`	`stopDatalake(StopDatalakeRequest input)`	Deprecated.
`SyncComponentVersionsFromCmResponse`	`syncComponentVersionsFromCm(SyncComponentVersionsFromCmRequest input)`	Syncs component versions from CM after a failed upgrade.
`UpdateOrchestratorStateResponse`	`updateOrchestratorState(UpdateOrchestratorStateRequest input)`	Run orchestrator engine state update on the Data Lake cluster.
`UpgradeDatalakeResponse`	`upgradeDatalake(UpgradeDatalakeRequest input)`	OS or data platform upgrade for the SDX cluster.
`ValidateAwsCloudStorageResponse`	`validateAwsCloudStorage(ValidateAwsCloudStorageRequest input)`	Validates AWS cloud storage.
`ValidateAzureCloudStorageResponse`	`validateAzureCloudStorage(ValidateAzureCloudStorageRequest input)`	Validates Azure cloud storage.

Methods inherited from class com.cloudera.cdp.client.CdpClient
invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DatalakeClient
```
public DatalakeClient(CdpCredentials credentials,
                      String endPoint,
                      CdpClientConfiguration clientConfiguration)
```
  - DatalakeClient
```
public DatalakeClient(CdpRequestContext<?> context)
```
- Method Detail
  - getServiceName
```
protected String getServiceName()
```
    Description copied from class: CdpClient
    
    Gets the service name.
    
    Specified by:
    
    getServiceName in class CdpClient
    
    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 class CdpClient
    
    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 class CdpClient
    
    Returns:
    
    the response Content-Type
  - backupDatalake
```
public BackupDatalakeResponse backupDatalake(BackupDatalakeRequest input)
```
    Create backup of datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    BackupDatalakeResponse
  - backupDatalakeStatus
```
public BackupDatalakeStatusResponse backupDatalakeStatus(BackupDatalakeStatusRequest input)
```
    Check the status of a datalake backup operation performed.
    
    Parameters:
    
    input -
    
    Returns:
    
    BackupDatalakeStatusResponse
  - cancelBackup
```
public CancelBackupResponse cancelBackup(CancelBackupRequest input)
```
    Cancels the specified ongoing backup operation.
    
    Parameters:
    
    input -
    
    Returns:
    
    CancelBackupResponse
  - cancelDatalakeDiagnostics
```
public CancelDatalakeDiagnosticsResponse cancelDatalakeDiagnostics(CancelDatalakeDiagnosticsRequest input)
```
    Cancel running Datalake diagnostics collections
    
    Parameters:
    
    input -
    
    Returns:
    
    CancelDatalakeDiagnosticsResponse
  - collectCmDiagnostics
```
public CollectCmDiagnosticsResponse collectCmDiagnostics(CollectCmDiagnosticsRequest input)
```
    Start DataLake Cloudera Manager based diagnostics collection
    
    Parameters:
    
    input -
    
    Returns:
    
    CollectCmDiagnosticsResponse
  - collectDatalakeDiagnostics
```
public CollectDatalakeDiagnosticsResponse collectDatalakeDiagnostics(CollectDatalakeDiagnosticsRequest input)
```
    Start DataLake diagnostics collection
    
    Parameters:
    
    input -
    
    Returns:
    
    CollectDatalakeDiagnosticsResponse
  - createAWSDatalake
```
public CreateAWSDatalakeResponse createAWSDatalake(CreateAWSDatalakeRequest input)
```
    Creates an AWS datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSDatalakeResponse
  - createAWSGovCloudDatalake
```
public CreateAWSGovCloudDatalakeResponse createAWSGovCloudDatalake(CreateAWSGovCloudDatalakeRequest input)
```
    Creates a Data Lake on AWS GovCloud.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSGovCloudDatalakeResponse
  - createAzureDatalake
```
public CreateAzureDatalakeResponse createAzureDatalake(CreateAzureDatalakeRequest input)
```
    Creates an Azure datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAzureDatalakeResponse
  - createGCPDatalake
```
public CreateGCPDatalakeResponse createGCPDatalake(CreateGCPDatalakeRequest input)
```
    Creates an GCP Data Lake.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateGCPDatalakeResponse
  - deleteDatalake
```
public DeleteDatalakeResponse deleteDatalake(DeleteDatalakeRequest input)
```
    Deletes a datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteDatalakeResponse
  - describeDatabaseServer
```
public DescribeDatabaseServerResponse describeDatabaseServer(DescribeDatabaseServerRequest input)
```
    Gets external database server details.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeDatabaseServerResponse
  - describeDatalake
```
public DescribeDatalakeResponse describeDatalake(DescribeDatalakeRequest input)
```
    Describes a datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeDatalakeResponse
  - 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
  - getDatalakeLogDescriptors
```
public GetDatalakeLogDescriptorsResponse getDatalakeLogDescriptors(GetDatalakeLogDescriptorsRequest input)
```
    Gather log descriptors that are used for diagnostics collection.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetDatalakeLogDescriptorsResponse
  - listDatalakeBackups
```
public ListDatalakeBackupsResponse listDatalakeBackups(ListDatalakeBackupsRequest input)
```
    List all the backup operations that were performed on the datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDatalakeBackupsResponse
  - listDatalakeDiagnostics
```
public ListDatalakeDiagnosticsResponse listDatalakeDiagnostics(ListDatalakeDiagnosticsRequest input)
```
    List recent Datalake diagnostics collections
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDatalakeDiagnosticsResponse
  - listDatalakes
```
public ListDatalakesResponse listDatalakes(ListDatalakesRequest input)
```
    Lists datalakes.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDatalakesResponse
  - listRuntimes
```
public ListRuntimesResponse listRuntimes(ListRuntimesRequest input)
```
    Lists the datalake versions.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListRuntimesResponse
  - prepareDatalakeUpgrade
```
public PrepareDatalakeUpgradeResponse prepareDatalakeUpgrade(PrepareDatalakeUpgradeRequest input)
```
    Prepares the Data Lake cluster for upgrade.
    
    Parameters:
    
    input -
    
    Returns:
    
    PrepareDatalakeUpgradeResponse
  - recoverDatalake
```
public RecoverDatalakeResponse recoverDatalake(RecoverDatalakeRequest input)
```
    Recover data lake to the original version after a failed upgrade.
    
    Parameters:
    
    input -
    
    Returns:
    
    RecoverDatalakeResponse
  - renewCertificate
```
@Deprecated
public RenewCertificateResponse renewCertificate(RenewCertificateRequest input)
```
    Deprecated.
    
    Renew certificate on Datalake cluster by name or CRN
    
    Parameters:
    
    input -
    
    Returns:
    
    RenewCertificateResponse
  - renewPublicCertificate
```
public RenewPublicCertificateResponse renewPublicCertificate(RenewPublicCertificateRequest input)
```
    Renews public certificate on Datalake cluster by name or CRN.
    
    Parameters:
    
    input -
    
    Returns:
    
    RenewPublicCertificateResponse
  - repairDatalake
```
public RepairDatalakeResponse repairDatalake(RepairDatalakeRequest input)
```
    Repairs a datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    RepairDatalakeResponse
  - replaceRecipes
```
public ReplaceRecipesResponse replaceRecipes(ReplaceRecipesRequest input)
```
    Replaces recipes for the given instance groups.
    
    Parameters:
    
    input -
    
    Returns:
    
    ReplaceRecipesResponse
  - resizeDatalake
```
public ResizeDatalakeResponse resizeDatalake(ResizeDatalakeRequest input)
```
    Resizes the given datalake to the given target size. Currently, the only valid use of this is for resizing a light duty datalake to a medium duty datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    ResizeDatalakeResponse
  - restoreDatalake
```
public RestoreDatalakeResponse restoreDatalake(RestoreDatalakeRequest input)
```
    Restore the datalake from backup taken.
    
    Parameters:
    
    input -
    
    Returns:
    
    RestoreDatalakeResponse
  - restoreDatalakeStatus
```
public RestoreDatalakeStatusResponse restoreDatalakeStatus(RestoreDatalakeStatusRequest input)
```
    Check the status of datalake restore operation.
    
    Parameters:
    
    input -
    
    Returns:
    
    RestoreDatalakeStatusResponse
  - retryDatalake
```
public RetryDatalakeResponse retryDatalake(RetryDatalakeRequest input)
```
    Retry last failed operation on a datalake.
    
    Parameters:
    
    input -
    
    Returns:
    
    RetryDatalakeResponse
  - rotateAutoTlsCertificates
```
@Deprecated
public RotateAutoTlsCertificatesResponse rotateAutoTlsCertificates(RotateAutoTlsCertificatesRequest input)
```
    Deprecated.
    
    Rotate autotls certificates on the datalake's hosts
    
    Parameters:
    
    input -
    
    Returns:
    
    RotateAutoTlsCertificatesResponse
  - rotatePrivateCertificates
```
public RotatePrivateCertificatesResponse rotatePrivateCertificates(RotatePrivateCertificatesRequest input)
```
    Rotates private certificates on the datalake's hosts.
    
    Parameters:
    
    input -
    
    Returns:
    
    RotatePrivateCertificatesResponse
  - rotateSaltPassword
```
public RotateSaltPasswordResponse rotateSaltPassword(RotateSaltPasswordRequest input)
```
    Rotate SaltStack user password on DataLake instances.
    
    Parameters:
    
    input -
    
    Returns:
    
    RotateSaltPasswordResponse
  - setCatalog
```
public SetCatalogResponse setCatalog(SetCatalogRequest input)
```
    Sets a catalog for a DataLake.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetCatalogResponse
  - startDatabaseUpgrade
```
public StartDatabaseUpgradeResponse startDatabaseUpgrade(StartDatabaseUpgradeRequest input)
```
    Upgrades the database of the Data Lake cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    StartDatabaseUpgradeResponse
  - startDatalake
```
@Deprecated
public StartDatalakeResponse startDatalake(StartDatalakeRequest input)
```
    Deprecated.
    
    Start Datalake
    
    Parameters:
    
    input -
    
    Returns:
    
    StartDatalakeResponse
  - startDatalakeVerticalScaling
```
public StartDatalakeVerticalScalingResponse startDatalakeVerticalScaling(StartDatalakeVerticalScalingRequest input)
```
    Initiates the vertical scaling on Data Lake.
    
    Parameters:
    
    input -
    
    Returns:
    
    StartDatalakeVerticalScalingResponse
  - stopDatalake
```
@Deprecated
public StopDatalakeResponse stopDatalake(StopDatalakeRequest input)
```
    Deprecated.
    
    Stop Datalake
    
    Parameters:
    
    input -
    
    Returns:
    
    StopDatalakeResponse
  - syncComponentVersionsFromCm
```
public SyncComponentVersionsFromCmResponse syncComponentVersionsFromCm(SyncComponentVersionsFromCmRequest input)
```
    Syncs component versions from CM after a failed upgrade.
    
    Parameters:
    
    input -
    
    Returns:
    
    SyncComponentVersionsFromCmResponse
  - updateOrchestratorState
```
public UpdateOrchestratorStateResponse updateOrchestratorState(UpdateOrchestratorStateRequest input)
```
    Run orchestrator engine state update on the Data Lake cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateOrchestratorStateResponse
  - upgradeDatalake
```
public UpgradeDatalakeResponse upgradeDatalake(UpgradeDatalakeRequest input)
```
    OS or data platform upgrade for the SDX cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeDatalakeResponse
  - validateAwsCloudStorage
```
public ValidateAwsCloudStorageResponse validateAwsCloudStorage(ValidateAwsCloudStorageRequest input)
```
    Validates AWS cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    ValidateAwsCloudStorageResponse
  - validateAzureCloudStorage
```
public ValidateAzureCloudStorageResponse validateAzureCloudStorage(ValidateAzureCloudStorageRequest input)
```
    Validates Azure cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    ValidateAzureCloudStorageResponse

Class DatalakeClient

Field Summary

Fields inherited from class com.cloudera.cdp.client.CdpClient

Constructor Summary

Method Summary

Methods inherited from class com.cloudera.cdp.client.CdpClient

Methods inherited from class java.lang.Object

Field Detail

SERVICE_NAME

Constructor Detail

DatalakeClient

DatalakeClient

Method Detail

getServiceName

getRequestContentType

getResponseContentType

backupDatalake

backupDatalakeStatus

cancelBackup

cancelDatalakeDiagnostics

collectCmDiagnostics

collectDatalakeDiagnostics

createAWSDatalake

createAWSGovCloudDatalake

createAzureDatalake

createGCPDatalake

deleteDatalake

describeDatabaseServer

describeDatalake

getClusterHostStatus

getClusterServiceStatus

getCmRoles

getDatalakeLogDescriptors

listDatalakeBackups

listDatalakeDiagnostics

listDatalakes

listRuntimes

prepareDatalakeUpgrade

recoverDatalake

renewCertificate

renewPublicCertificate

repairDatalake

replaceRecipes

resizeDatalake

restoreDatalake

restoreDatalakeStatus

retryDatalake

rotateAutoTlsCertificates

rotatePrivateCertificates

rotateSaltPassword

setCatalog

startDatabaseUpgrade

startDatalake

startDatalakeVerticalScaling

stopDatalake

syncComponentVersionsFromCm

updateOrchestratorState

upgradeDatalake

validateAwsCloudStorage

validateAzureCloudStorage