java.lang.Object
- com.cloudera.cdp.client.CdpClient
- - com.cloudera.cdp.df.api.DfClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2024-06-05T15:31:00.324-07:00")
public class DfClient
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
`DfClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)`
`DfClient(CdpRequestContext<?> context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AddReadyflowResponse`	`addReadyflow(AddReadyflowRequest input)`	Add ready flow.
`CancelDeleteProjectResponse`	`cancelDeleteProject(CancelDeleteProjectRequest input)`	Cancels deletion of a Project.
`CreateFlowVersionTagResponse`	`createFlowVersionTag(CreateFlowVersionTagRequest input)`	Create flow version tag.
`CreateProjectResponse`	`createProject(CreateProjectRequest input)`	Creates a Project.
`DeleteAddedReadyflowResponse`	`deleteAddedReadyflow(DeleteAddedReadyflowRequest input)`	Delete added ready flow.
`DeleteFlowResponse`	`deleteFlow(DeleteFlowRequest input)`	Delete flow.
`DeleteFlowVersionTagResponse`	`deleteFlowVersionTag(DeleteFlowVersionTagRequest input)`	Delete flow version tag.
`DeleteProjectResponse`	`deleteProject(DeleteProjectRequest input)`	Deletes a Project.
`DescribeAddedReadyflowResponse`	`describeAddedReadyflow(DescribeAddedReadyflowRequest input)`	Describe added ready flow detail.
`DescribeDeploymentResponse`	`describeDeployment(DescribeDeploymentRequest input)`	Describe deployment.
`DescribeDeploymentEventDetailResponse`	`describeDeploymentEventDetail(DescribeDeploymentEventDetailRequest input)`	Describe event detail for deployment.
`DescribeFlowResponse`	`describeFlow(DescribeFlowRequest input)`	Describe flow.
`DescribeProjectResponse`	`describeProject(DescribeProjectRequest input)`	Describes a Project.
`DescribeReadyflowResponse`	`describeReadyflow(DescribeReadyflowRequest input)`	Describe ready flow.
`DescribeServiceResponse`	`describeService(DescribeServiceRequest input)`	Describe service.
`DescribeServiceEventDetailResponse`	`describeServiceEventDetail(DescribeServiceEventDetailRequest input)`	Describe event history detail for service.
`DisableServiceResponse`	`disableService(DisableServiceRequest input)`	Disable service.
`EnableServiceResponse`	`enableService(EnableServiceRequest input)`	Enable DataFlow service from a CDP environment.
`GetFlowVersionResponse`	`getFlowVersion(GetFlowVersionRequest input)`	Get flow version.
`GetKubeconfigResponse`	`getKubeconfig(GetKubeconfigRequest input)`	Get Kubeconfig.
`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.
`GrantUserKubernetesAccessResponse`	`grantUserKubernetesAccess(GrantUserKubernetesAccessRequest input)`	Grant remote user access to the service's cluster.
`ImportFlowDefinitionResponse`	`importFlowDefinition(ImportFlowDefinitionRequest input)`	Import a new flow definition.
`ImportFlowDefinitionVersionResponse`	`importFlowDefinitionVersion(ImportFlowDefinitionVersionRequest input)`	Import a new flow definition version to an existing flow.
`InitiateDeploymentResponse`	`initiateDeployment(InitiateDeploymentRequest input)`	Initiate a deployment creation.
`ListDeployableServicesForNewDeploymentsResponse`	`listDeployableServicesForNewDeployments(ListDeployableServicesForNewDeploymentsRequest input)`	List services that a DataFlow Admin can deploy to.
`ListDeploymentActiveAlertsResponse`	`listDeploymentActiveAlerts(ListDeploymentActiveAlertsRequest input)`	List active alerts for deployment.
`ListDeploymentEventsResponse`	`listDeploymentEvents(ListDeploymentEventsRequest input)`	List event history for deployment.
`ListDeploymentKPIsResponse`	`listDeploymentKPIs(ListDeploymentKPIsRequest input)`	List deployment KPIs.
`ListDeploymentsResponse`	`listDeployments(ListDeploymentsRequest input)`	List deployments.
`ListDeploymentSystemMetricsResponse`	`listDeploymentSystemMetrics(ListDeploymentSystemMetricsRequest input)`	List deployment System metrics.
`ListDiagnosticsResponse`	`listDiagnostics(ListDiagnosticsRequest input)`	List diagnostics.
`ListFilterOptionsResponse`	`listFilterOptions(ListFilterOptionsRequest input)`	List filter options.
`ListFlowDefinitionsResponse`	`listFlowDefinitions(ListFlowDefinitionsRequest input)`	List flow definitions.
`ListFlowDefinitionVersionsResponse`	`listFlowDefinitionVersions(ListFlowDefinitionVersionsRequest input)`	List flow definition versions.
`ListFlowVersionTagsResponse`	`listFlowVersionTags(ListFlowVersionTagsRequest input)`	List flow version tags.
`ListNotificationsResponse`	`listNotifications(ListNotificationsRequest input)`	List notifications.
`ListProjectFilterOptionsResponse`	`listProjectFilterOptions(ListProjectFilterOptionsRequest input)`	List filter options.
`ListProjectsResponse`	`listProjects(ListProjectsRequest input)`	List Projects.
`ListReadyflowsResponse`	`listReadyflows(ListReadyflowsRequest input)`	List ready flows.
`ListServiceActiveAlertsResponse`	`listServiceActiveAlerts(ListServiceActiveAlertsRequest input)`	List active alerts for service.
`ListServiceEventsResponse`	`listServiceEvents(ListServiceEventsRequest input)`	List events for service.
`ListServicesResponse`	`listServices(ListServicesRequest input)`	List services.
`ListServiceSystemMetricsResponse`	`listServiceSystemMetrics(ListServiceSystemMetricsRequest input)`	List service System metrics.
`ListUserKubernetesAccessResponse`	`listUserKubernetesAccess(ListUserKubernetesAccessRequest input)`	List users that have access to the service's cluster.
`RenewCertificatesResponse`	`renewCertificates(RenewCertificatesRequest input)`	Renew workload UI certificates.
`ResetServiceResponse`	`resetService(ResetServiceRequest input)`	Resets all references to a service.
`RevokeUserKubernetesAccessResponse`	`revokeUserKubernetesAccess(RevokeUserKubernetesAccessRequest input)`	Revoke access for the remote user from the service's cluster.
`StartGetDiagnosticsCollectionResponse`	`startGetDiagnosticsCollection(StartGetDiagnosticsCollectionRequest input)`	Start diagnostics collection.
`UpdateProjectResponse`	`updateProject(UpdateProjectRequest input)`	Updates a Project.
`UpdateServiceResponse`	`updateService(UpdateServiceRequest input)`	Update service.
`UpgradeServiceResponse`	`upgradeService(UpgradeServiceRequest input)`	Upgrade service.

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
  - DfClient
```
public DfClient(CdpCredentials credentials,
                String endPoint,
                CdpClientConfiguration clientConfiguration)
```
  - DfClient
```
public DfClient(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
  - addReadyflow
```
public AddReadyflowResponse addReadyflow(AddReadyflowRequest input)
```
    Add ready flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    AddReadyflowResponse
  - cancelDeleteProject
```
public CancelDeleteProjectResponse cancelDeleteProject(CancelDeleteProjectRequest input)
```
    Cancels deletion of a Project.
    
    Parameters:
    
    input -
    
    Returns:
    
    CancelDeleteProjectResponse
  - createFlowVersionTag
```
public CreateFlowVersionTagResponse createFlowVersionTag(CreateFlowVersionTagRequest input)
```
    Create flow version tag.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateFlowVersionTagResponse
  - createProject
```
public CreateProjectResponse createProject(CreateProjectRequest input)
```
    Creates a Project.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateProjectResponse
  - deleteAddedReadyflow
```
public DeleteAddedReadyflowResponse deleteAddedReadyflow(DeleteAddedReadyflowRequest input)
```
    Delete added ready flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteAddedReadyflowResponse
  - deleteFlow
```
public DeleteFlowResponse deleteFlow(DeleteFlowRequest input)
```
    Delete flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteFlowResponse
  - deleteFlowVersionTag
```
public DeleteFlowVersionTagResponse deleteFlowVersionTag(DeleteFlowVersionTagRequest input)
```
    Delete flow version tag.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteFlowVersionTagResponse
  - deleteProject
```
public DeleteProjectResponse deleteProject(DeleteProjectRequest input)
```
    Deletes a Project.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteProjectResponse
  - describeAddedReadyflow
```
public DescribeAddedReadyflowResponse describeAddedReadyflow(DescribeAddedReadyflowRequest input)
```
    Describe added ready flow detail.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeAddedReadyflowResponse
  - describeDeployment
```
public DescribeDeploymentResponse describeDeployment(DescribeDeploymentRequest input)
```
    Describe deployment.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeDeploymentResponse
  - describeDeploymentEventDetail
```
public DescribeDeploymentEventDetailResponse describeDeploymentEventDetail(DescribeDeploymentEventDetailRequest input)
```
    Describe event detail for deployment.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeDeploymentEventDetailResponse
  - describeFlow
```
public DescribeFlowResponse describeFlow(DescribeFlowRequest input)
```
    Describe flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeFlowResponse
  - describeProject
```
public DescribeProjectResponse describeProject(DescribeProjectRequest input)
```
    Describes a Project.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeProjectResponse
  - describeReadyflow
```
public DescribeReadyflowResponse describeReadyflow(DescribeReadyflowRequest input)
```
    Describe ready flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeReadyflowResponse
  - describeService
```
public DescribeServiceResponse describeService(DescribeServiceRequest input)
```
    Describe service.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeServiceResponse
  - describeServiceEventDetail
```
public DescribeServiceEventDetailResponse describeServiceEventDetail(DescribeServiceEventDetailRequest input)
```
    Describe event history detail for service.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeServiceEventDetailResponse
  - disableService
```
public DisableServiceResponse disableService(DisableServiceRequest input)
```
    Disable service.
    
    Parameters:
    
    input -
    
    Returns:
    
    DisableServiceResponse
  - enableService
```
public EnableServiceResponse enableService(EnableServiceRequest input)
```
    Enable DataFlow service from a CDP environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    EnableServiceResponse
  - getFlowVersion
```
public GetFlowVersionResponse getFlowVersion(GetFlowVersionRequest input)
```
    Get flow version.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetFlowVersionResponse
  - getKubeconfig
```
public GetKubeconfigResponse getKubeconfig(GetKubeconfigRequest input)
```
    Get Kubeconfig.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetKubeconfigResponse
  - grantUserKubernetesAccess
```
public GrantUserKubernetesAccessResponse grantUserKubernetesAccess(GrantUserKubernetesAccessRequest input)
```
    Grant remote user access to the service's cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    GrantUserKubernetesAccessResponse
  - importFlowDefinition
```
public ImportFlowDefinitionResponse importFlowDefinition(ImportFlowDefinitionRequest input)
```
    Import a new flow definition.
    
    Parameters:
    
    input -
    
    Returns:
    
    ImportFlowDefinitionResponse
  - importFlowDefinitionVersion
```
public ImportFlowDefinitionVersionResponse importFlowDefinitionVersion(ImportFlowDefinitionVersionRequest input)
```
    Import a new flow definition version to an existing flow.
    
    Parameters:
    
    input -
    
    Returns:
    
    ImportFlowDefinitionVersionResponse
  - initiateDeployment
```
public InitiateDeploymentResponse initiateDeployment(InitiateDeploymentRequest input)
```
    Initiate a deployment creation.
    
    Parameters:
    
    input -
    
    Returns:
    
    InitiateDeploymentResponse
  - listDeployableServicesForNewDeployments
```
public ListDeployableServicesForNewDeploymentsResponse listDeployableServicesForNewDeployments(ListDeployableServicesForNewDeploymentsRequest input)
```
    List services that a DataFlow Admin can deploy to.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeployableServicesForNewDeploymentsResponse
  - listDeploymentActiveAlerts
```
public ListDeploymentActiveAlertsResponse listDeploymentActiveAlerts(ListDeploymentActiveAlertsRequest input)
```
    List active alerts for deployment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeploymentActiveAlertsResponse
  - listDeploymentEvents
```
public ListDeploymentEventsResponse listDeploymentEvents(ListDeploymentEventsRequest input)
```
    List event history for deployment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeploymentEventsResponse
  - listDeploymentKPIs
```
public ListDeploymentKPIsResponse listDeploymentKPIs(ListDeploymentKPIsRequest input)
```
    List deployment KPIs.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeploymentKPIsResponse
  - listDeploymentSystemMetrics
```
public ListDeploymentSystemMetricsResponse listDeploymentSystemMetrics(ListDeploymentSystemMetricsRequest input)
```
    List deployment System metrics.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeploymentSystemMetricsResponse
  - listDeployments
```
public ListDeploymentsResponse listDeployments(ListDeploymentsRequest input)
```
    List deployments.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDeploymentsResponse
  - listDiagnostics
```
public ListDiagnosticsResponse listDiagnostics(ListDiagnosticsRequest input)
```
    List diagnostics.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListDiagnosticsResponse
  - listFilterOptions
```
public ListFilterOptionsResponse listFilterOptions(ListFilterOptionsRequest input)
```
    List filter options.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListFilterOptionsResponse
  - listFlowDefinitionVersions
```
public ListFlowDefinitionVersionsResponse listFlowDefinitionVersions(ListFlowDefinitionVersionsRequest input)
```
    List flow definition versions.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListFlowDefinitionVersionsResponse
  - listFlowDefinitions
```
public ListFlowDefinitionsResponse listFlowDefinitions(ListFlowDefinitionsRequest input)
```
    List flow definitions.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListFlowDefinitionsResponse
  - listFlowVersionTags
```
public ListFlowVersionTagsResponse listFlowVersionTags(ListFlowVersionTagsRequest input)
```
    List flow version tags.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListFlowVersionTagsResponse
  - listNotifications
```
public ListNotificationsResponse listNotifications(ListNotificationsRequest input)
```
    List notifications.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListNotificationsResponse
  - listProjectFilterOptions
```
public ListProjectFilterOptionsResponse listProjectFilterOptions(ListProjectFilterOptionsRequest input)
```
    List filter options.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListProjectFilterOptionsResponse
  - listProjects
```
public ListProjectsResponse listProjects(ListProjectsRequest input)
```
    List Projects.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListProjectsResponse
  - listReadyflows
```
public ListReadyflowsResponse listReadyflows(ListReadyflowsRequest input)
```
    List ready flows.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListReadyflowsResponse
  - listServiceActiveAlerts
```
public ListServiceActiveAlertsResponse listServiceActiveAlerts(ListServiceActiveAlertsRequest input)
```
    List active alerts for service.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListServiceActiveAlertsResponse
  - listServiceEvents
```
public ListServiceEventsResponse listServiceEvents(ListServiceEventsRequest input)
```
    List events for service.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListServiceEventsResponse
  - listServiceSystemMetrics
```
public ListServiceSystemMetricsResponse listServiceSystemMetrics(ListServiceSystemMetricsRequest input)
```
    List service System metrics.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListServiceSystemMetricsResponse
  - listServices
```
public ListServicesResponse listServices(ListServicesRequest input)
```
    List services.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListServicesResponse
  - listUserKubernetesAccess
```
public ListUserKubernetesAccessResponse listUserKubernetesAccess(ListUserKubernetesAccessRequest input)
```
    List users that have access to the service's cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListUserKubernetesAccessResponse
  - renewCertificates
```
public RenewCertificatesResponse renewCertificates(RenewCertificatesRequest input)
```
    Renew workload UI certificates.
    
    Parameters:
    
    input -
    
    Returns:
    
    RenewCertificatesResponse
  - resetService
```
public ResetServiceResponse resetService(ResetServiceRequest input)
```
    Resets all references to a service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.
    
    Parameters:
    
    input -
    
    Returns:
    
    ResetServiceResponse
  - revokeUserKubernetesAccess
```
public RevokeUserKubernetesAccessResponse revokeUserKubernetesAccess(RevokeUserKubernetesAccessRequest input)
```
    Revoke access for the remote user from the service's cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    RevokeUserKubernetesAccessResponse
  - startGetDiagnosticsCollection
```
public StartGetDiagnosticsCollectionResponse startGetDiagnosticsCollection(StartGetDiagnosticsCollectionRequest input)
```
    Start diagnostics collection.
    
    Parameters:
    
    input -
    
    Returns:
    
    StartGetDiagnosticsCollectionResponse
  - updateProject
```
public UpdateProjectResponse updateProject(UpdateProjectRequest input)
```
    Updates a Project.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateProjectResponse
  - updateService
```
public UpdateServiceResponse updateService(UpdateServiceRequest input)
```
    Update service.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateServiceResponse
  - upgradeService
```
public UpgradeServiceResponse upgradeService(UpgradeServiceRequest input)
```
    Upgrade service.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeServiceResponse

Class DfClient

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

DfClient

DfClient

Method Detail

getServiceName

getRequestContentType

getResponseContentType

addReadyflow

cancelDeleteProject

createFlowVersionTag

createProject

deleteAddedReadyflow

deleteFlow

deleteFlowVersionTag

deleteProject

describeAddedReadyflow

describeDeployment

describeDeploymentEventDetail

describeFlow

describeProject

describeReadyflow

describeService

describeServiceEventDetail

disableService

enableService

getFlowVersion

getKubeconfig

grantUserKubernetesAccess

importFlowDefinition

importFlowDefinitionVersion

initiateDeployment

listDeployableServicesForNewDeployments

listDeploymentActiveAlerts

listDeploymentEvents

listDeploymentKPIs

listDeploymentSystemMetrics

listDeployments

listDiagnostics

listFilterOptions

listFlowDefinitionVersions

listFlowDefinitions

listFlowVersionTags

listNotifications

listProjectFilterOptions

listProjects

listReadyflows

listServiceActiveAlerts

listServiceEvents

listServiceSystemMetrics

listServices

listUserKubernetesAccess

renewCertificates

resetService

revokeUserKubernetesAccess

startGetDiagnosticsCollection

updateProject

updateService

upgradeService