Package com.cloudera.cdp.df.api
Class DfClient
java.lang.Object
com.cloudera.cdp.client.CdpClient
com.cloudera.cdp.df.api.DfClient
@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2025-10-28T14:00:30.597-07:00")
public class DfClient
extends CdpClient
- 
Field SummaryFieldsFields inherited from class com.cloudera.cdp.client.CdpClientNO_EXTENSION
- 
Constructor SummaryConstructorsConstructorDescriptionDfClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) DfClient(CdpRequestContext<?> context) 
- 
Method SummaryModifier and TypeMethodDescriptionaddReadyflow(AddReadyflowRequest input) Add ready flow.Assign a flow definition to collection.Cancels deletion of a Project.Create catalog collection.Create flow version tag.Creates a Project.Delete added ready flow.Delete catalog collection.deleteFlow(DeleteFlowRequest input) Delete flow.Delete flow version tag.Deletes a Project.Describe added ready flow detail.Describe catalog collection.Describe deployment.Describe event detail for deployment.describeFlow(DescribeFlowRequest input) Describe flow.Describes a Project.Describe ready flow.Describe service.Describe event history detail for service.Disable service.Enable DataFlow service from a CDP environment.Get flow version.Get Kubeconfig.protected StringGets the request Content-Type, used by 'Conent-Type' request header.protected StringGets the expected response Content-Type, used by 'Accept' request header.protected StringGets the service name.Grant remote user access to the service's cluster.Import a new flow definition.Import a new flow definition version to an existing flow.Initiate a deployment creation.List catalog collections.List services that a DataFlow Admin can deploy to.List active alerts for deployment.List event history for deployment.List deployment KPIs.List deployments.List deployment System metrics.List diagnostics.List filter options.List flow definitions.List flow definition versions.List flow version tags.List notifications.List filter options.listProjects(ListProjectsRequest input) List Projects.List ready flows.List active alerts for service.List events for service.listServices(ListServicesRequest input) List services.List service System metrics.List users that have access to the service's cluster.Renew workload UI certificates.resetService(ResetServiceRequest input) Resets all references to a service.Revoke access for the remote user from the service's cluster.Rotate password.Start diagnostics collection.Update a collection's details.Updates a Project.Update service.Upgrade service.Methods inherited from class com.cloudera.cdp.client.CdpClientinvokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown
- 
Field Details- 
SERVICE_NAME- See Also:
 
 
- 
- 
Constructor Details- 
DfClientpublic DfClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) 
- 
DfClient
 
- 
- 
Method Details- 
getServiceNameDescription copied from class:CdpClientGets the service name.- Specified by:
- getServiceNamein class- CdpClient
- Returns:
- the service name
 
- 
getRequestContentTypeDescription copied from class:CdpClientGets the request Content-Type, used by 'Conent-Type' request header.- Overrides:
- getRequestContentTypein class- CdpClient
- Returns:
- the request Content-Type
 
- 
getResponseContentTypeDescription copied from class:CdpClientGets the expected response Content-Type, used by 'Accept' request header.- Overrides:
- getResponseContentTypein class- CdpClient
- Returns:
- the response Content-Type
 
- 
addReadyflowAdd ready flow.- Parameters:
- input-
- Returns:
- AddReadyflowResponse
 
- 
assignToCollectionAssign a flow definition to collection.- Parameters:
- input-
- Returns:
- AssignToCollectionResponse
 
- 
cancelDeleteProjectCancels deletion of a Project.- Parameters:
- input-
- Returns:
- CancelDeleteProjectResponse
 
- 
createCollectionCreate catalog collection.- Parameters:
- input-
- Returns:
- CreateCollectionResponse
 
- 
createFlowVersionTagCreate flow version tag.- Parameters:
- input-
- Returns:
- CreateFlowVersionTagResponse
 
- 
createProjectCreates a Project.- Parameters:
- input-
- Returns:
- CreateProjectResponse
 
- 
deleteAddedReadyflowDelete added ready flow.- Parameters:
- input-
- Returns:
- DeleteAddedReadyflowResponse
 
- 
deleteCollectionDelete catalog collection.- Parameters:
- input-
- Returns:
- DeleteCollectionResponse
 
- 
deleteFlowDelete flow.- Parameters:
- input-
- Returns:
- DeleteFlowResponse
 
- 
deleteFlowVersionTagDelete flow version tag.- Parameters:
- input-
- Returns:
- DeleteFlowVersionTagResponse
 
- 
deleteProjectDeletes a Project.- Parameters:
- input-
- Returns:
- DeleteProjectResponse
 
- 
describeAddedReadyflowDescribe added ready flow detail.- Parameters:
- input-
- Returns:
- DescribeAddedReadyflowResponse
 
- 
describeCollectionDescribe catalog collection.- Parameters:
- input-
- Returns:
- DescribeCollectionResponse
 
- 
describeDeploymentDescribe deployment.- Parameters:
- input-
- Returns:
- DescribeDeploymentResponse
 
- 
describeDeploymentEventDetailpublic DescribeDeploymentEventDetailResponse describeDeploymentEventDetail(DescribeDeploymentEventDetailRequest input) Describe event detail for deployment.- Parameters:
- input-
- Returns:
- DescribeDeploymentEventDetailResponse
 
- 
describeFlowDescribe flow.- Parameters:
- input-
- Returns:
- DescribeFlowResponse
 
- 
describeProjectDescribes a Project.- Parameters:
- input-
- Returns:
- DescribeProjectResponse
 
- 
describeReadyflowDescribe ready flow.- Parameters:
- input-
- Returns:
- DescribeReadyflowResponse
 
- 
describeServiceDescribe service.- Parameters:
- input-
- Returns:
- DescribeServiceResponse
 
- 
describeServiceEventDetailpublic DescribeServiceEventDetailResponse describeServiceEventDetail(DescribeServiceEventDetailRequest input) Describe event history detail for service.- Parameters:
- input-
- Returns:
- DescribeServiceEventDetailResponse
 
- 
disableServiceDisable service.- Parameters:
- input-
- Returns:
- DisableServiceResponse
 
- 
enableServiceEnable DataFlow service from a CDP environment.- Parameters:
- input-
- Returns:
- EnableServiceResponse
 
- 
getFlowVersionGet flow version.- Parameters:
- input-
- Returns:
- GetFlowVersionResponse
 
- 
getKubeconfigGet Kubeconfig.- Parameters:
- input-
- Returns:
- GetKubeconfigResponse
 
- 
grantUserKubernetesAccesspublic GrantUserKubernetesAccessResponse grantUserKubernetesAccess(GrantUserKubernetesAccessRequest input) Grant remote user access to the service's cluster.- Parameters:
- input-
- Returns:
- GrantUserKubernetesAccessResponse
 
- 
importFlowDefinitionImport a new flow definition.- Parameters:
- input-
- Returns:
- ImportFlowDefinitionResponse
 
- 
importFlowDefinitionVersionpublic ImportFlowDefinitionVersionResponse importFlowDefinitionVersion(ImportFlowDefinitionVersionRequest input) Import a new flow definition version to an existing flow.- Parameters:
- input-
- Returns:
- ImportFlowDefinitionVersionResponse
 
- 
initiateDeploymentInitiate a deployment creation.- Parameters:
- input-
- Returns:
- InitiateDeploymentResponse
 
- 
listCollectionsList catalog collections.- Parameters:
- input-
- Returns:
- ListCollectionsResponse
 
- 
listDeployableServicesForNewDeploymentspublic ListDeployableServicesForNewDeploymentsResponse listDeployableServicesForNewDeployments(ListDeployableServicesForNewDeploymentsRequest input) List services that a DataFlow Admin can deploy to.- Parameters:
- input-
- Returns:
- ListDeployableServicesForNewDeploymentsResponse
 
- 
listDeploymentActiveAlertspublic ListDeploymentActiveAlertsResponse listDeploymentActiveAlerts(ListDeploymentActiveAlertsRequest input) List active alerts for deployment.- Parameters:
- input-
- Returns:
- ListDeploymentActiveAlertsResponse
 
- 
listDeploymentEventsList event history for deployment.- Parameters:
- input-
- Returns:
- ListDeploymentEventsResponse
 
- 
listDeploymentKPIsList deployment KPIs.- Parameters:
- input-
- Returns:
- ListDeploymentKPIsResponse
 
- 
listDeploymentSystemMetricspublic ListDeploymentSystemMetricsResponse listDeploymentSystemMetrics(ListDeploymentSystemMetricsRequest input) List deployment System metrics.- Parameters:
- input-
- Returns:
- ListDeploymentSystemMetricsResponse
 
- 
listDeploymentsList deployments.- Parameters:
- input-
- Returns:
- ListDeploymentsResponse
 
- 
listDiagnosticsList diagnostics.- Parameters:
- input-
- Returns:
- ListDiagnosticsResponse
 
- 
listFilterOptionsList filter options.- Parameters:
- input-
- Returns:
- ListFilterOptionsResponse
 
- 
listFlowDefinitionVersionspublic ListFlowDefinitionVersionsResponse listFlowDefinitionVersions(ListFlowDefinitionVersionsRequest input) List flow definition versions.- Parameters:
- input-
- Returns:
- ListFlowDefinitionVersionsResponse
 
- 
listFlowDefinitionsList flow definitions.- Parameters:
- input-
- Returns:
- ListFlowDefinitionsResponse
 
- 
listFlowVersionTagsList flow version tags.- Parameters:
- input-
- Returns:
- ListFlowVersionTagsResponse
 
- 
listNotificationsList notifications.- Parameters:
- input-
- Returns:
- ListNotificationsResponse
 
- 
listProjectFilterOptionspublic ListProjectFilterOptionsResponse listProjectFilterOptions(ListProjectFilterOptionsRequest input) List filter options.- Parameters:
- input-
- Returns:
- ListProjectFilterOptionsResponse
 
- 
listProjectsList Projects.- Parameters:
- input-
- Returns:
- ListProjectsResponse
 
- 
listReadyflowsList ready flows.- Parameters:
- input-
- Returns:
- ListReadyflowsResponse
 
- 
listServiceActiveAlertspublic ListServiceActiveAlertsResponse listServiceActiveAlerts(ListServiceActiveAlertsRequest input) List active alerts for service.- Parameters:
- input-
- Returns:
- ListServiceActiveAlertsResponse
 
- 
listServiceEventsList events for service.- Parameters:
- input-
- Returns:
- ListServiceEventsResponse
 
- 
listServiceSystemMetricspublic ListServiceSystemMetricsResponse listServiceSystemMetrics(ListServiceSystemMetricsRequest input) List service System metrics.- Parameters:
- input-
- Returns:
- ListServiceSystemMetricsResponse
 
- 
listServicesList services.- Parameters:
- input-
- Returns:
- ListServicesResponse
 
- 
listUserKubernetesAccesspublic ListUserKubernetesAccessResponse listUserKubernetesAccess(ListUserKubernetesAccessRequest input) List users that have access to the service's cluster.- Parameters:
- input-
- Returns:
- ListUserKubernetesAccessResponse
 
- 
renewCertificatesRenew workload UI certificates.- Parameters:
- input-
- Returns:
- RenewCertificatesResponse
 
- 
resetServiceResets all references to a service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.- Parameters:
- input-
- Returns:
- ResetServiceResponse
 
- 
revokeUserKubernetesAccesspublic RevokeUserKubernetesAccessResponse revokeUserKubernetesAccess(RevokeUserKubernetesAccessRequest input) Revoke access for the remote user from the service's cluster.- Parameters:
- input-
- Returns:
- RevokeUserKubernetesAccessResponse
 
- 
rotatePasswordRotate password.- Parameters:
- input-
- Returns:
- RotatePasswordResponse
 
- 
startGetDiagnosticsCollectionpublic StartGetDiagnosticsCollectionResponse startGetDiagnosticsCollection(StartGetDiagnosticsCollectionRequest input) Start diagnostics collection.- Parameters:
- input-
- Returns:
- StartGetDiagnosticsCollectionResponse
 
- 
updateCollectionUpdate a collection's details.- Parameters:
- input-
- Returns:
- UpdateCollectionResponse
 
- 
updateProjectUpdates a Project.- Parameters:
- input-
- Returns:
- UpdateProjectResponse
 
- 
updateServiceUpdate service.- Parameters:
- input-
- Returns:
- UpdateServiceResponse
 
- 
upgradeServiceUpgrade service.- Parameters:
- input-
- Returns:
- UpgradeServiceResponse
 
 
-