Package com.cloudera.cdp.dfworkload.api

Class DfworkloadClient

java.lang.Object

com.cloudera.cdp.client.CdpClient

com.cloudera.cdp.dfworkload.api.DfworkloadClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2025-05-14T11:34:38.216-07:00")
public class DfworkloadClient
extends CdpClient

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_NAME

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

NO_EXTENSION

Constructor Summary

Constructors

Constructor	Description
DfworkloadClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
DfworkloadClient(CdpRequestContext<?> context)

Method Summary

Modifier and Type	Method	Description
AbortAssetUpdateRequestResponse	abortAssetUpdateRequest(AbortAssetUpdateRequestRequest input)	Aborts asset update request.
AbortDeploymentRequestResponse	abortDeploymentRequest(AbortDeploymentRequestRequest input)	Aborts a deployment request.
CancelChangeFlowVersionResponse	cancelChangeFlowVersion(CancelChangeFlowVersionRequest input)	Cancel change flow version for an existing deployment.
CancelNifiVersionUpdateResponse	cancelNifiVersionUpdate(CancelNifiVersionUpdateRequest input)	Cancels a NiFi version update for a deployment.
ChangeFlowVersionResponse	changeFlowVersion(ChangeFlowVersionRequest input)	Change flow version of a running deployment.
CreateAssetUpdateRequestResponse	createAssetUpdateRequest(CreateAssetUpdateRequestRequest input)	Create asset update request.
CreateCustomNarConfigurationResponse	createCustomNarConfiguration(CreateCustomNarConfigurationRequest input)	Create the custom NAR configuration.
CreateCustomPythonConfigurationResponse	createCustomPythonConfiguration(CreateCustomPythonConfigurationRequest input)	Create the custom Python configuration.
CreateDeploymentResponse	createDeployment(CreateDeploymentRequest input)	Creates a deployment.
CreateInboundConnectionEndpointResponse	createInboundConnectionEndpoint(CreateInboundConnectionEndpointRequest input)	Create Inbound Connection Endpoint
CreateReportingTaskResponse	createReportingTask(CreateReportingTaskRequest input)	Creates a reporting task.
DeleteCustomNarConfigurationResponse	deleteCustomNarConfiguration(DeleteCustomNarConfigurationRequest input)	Deletes an orphaned custom NAR configuration.
DeleteCustomPythonConfigurationResponse	deleteCustomPythonConfiguration(DeleteCustomPythonConfigurationRequest input)	Deletes an orphaned custom Python configuration.
DeleteInboundConnectionEndpointResponse	deleteInboundConnectionEndpoint(DeleteInboundConnectionEndpointRequest input)	Delete Inbound Connection Endpoint
DeleteReportingTaskResponse	deleteReportingTask(DeleteReportingTaskRequest input)	Deletes a reporting task.
DescribeInboundConnectionEndpointResponse	describeInboundConnectionEndpoint(DescribeInboundConnectionEndpointRequest input)	Describe Inbound Connection Endpoint
ExportDeploymentResponse	exportDeployment(ExportDeploymentRequest input)	Export deployment configuration.
InboundConnectionEndpointClientCertificateResponse	getClientCertificateEncoded(InboundConnectionEndpointClientCertificateRequest input)	Deprecated.
InboundConnectionEndpointClientCertificatesResponse	getClientCertificatesEncoded(InboundConnectionEndpointClientCertificatesRequest input)	Get Inbound Connection Endpoint Client Certificates (in PEM encoding)
InboundConnectionEndpointClientPrivateKeyResponse	getClientPrivateKeyEncoded(InboundConnectionEndpointClientPrivateKeyRequest input)	Deprecated.
GetCustomNarConfigurationResponse	getCustomNarConfiguration(GetCustomNarConfigurationRequest input)	Get a custom NAR configuration.
GetCustomPythonConfigurationResponse	getCustomPythonConfiguration(GetCustomPythonConfigurationRequest input)	Get a custom Python configuration.
GetDefaultCustomNarConfigurationResponse	getDefaultCustomNarConfiguration(GetDefaultCustomNarConfigurationRequest input)	Get the default custom NAR configuration.
GetDeploymentConfigurationResponse	getDeploymentConfiguration(GetDeploymentConfigurationRequest input)	Retrieves the deployment configuration.
GetDeploymentConfigurationMetadataResponse	getDeploymentConfigurationMetadata(GetDeploymentConfigurationMetadataRequest input)	Retrieves the deployment configuration metadata.
GetDeploymentRequestDetailsResponse	getDeploymentRequestDetails(GetDeploymentRequestDetailsRequest input)	Retrieves deployment request details.
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.
ImportDeploymentResponse	importDeployment(ImportDeploymentRequest input)	Import deployment configuration.
ListDeploymentArchivesResponse	listDeploymentArchives(ListDeploymentArchivesRequest input)	Lists the exported archive metadata of all deployments.
ListInboundConnectionEndpointsResponse	listInboundConnectionEndpoints(ListInboundConnectionEndpointsRequest input)	List Inbound Connection Endpoints
ListNifiVersionsResponse	listNifiVersions(ListNifiVersionsRequest input)	Lists all supported NiFi versions.
ListReportingTasksResponse	listReportingTasks(ListReportingTasksRequest input)	Lists all reporting tasks for a deployment.
ReassignResourcesResponse	reassignResources(ReassignResourcesRequest input)	Modifies the project assignment of the given workload resources.
RenewInboundConnectionEndpointCertificateResponse	renewInboundConnectionEndpointCertificates(RenewInboundConnectionEndpointCertificateRequest body)	Renew Inbound Connection Endpoint certificates
RestartDeploymentResponse	restartDeployment(RestartDeploymentRequest input)	Restart a deployment.
ResumeDeploymentResponse	resumeDeployment(ResumeDeploymentRequest input)	Resumes a deployment.
StartFlowResponse	startFlow(StartFlowRequest input)	Starts a flow.
StopFlowResponse	stopFlow(StopFlowRequest input)	Stops a flow.
SuspendDeploymentResponse	suspendDeployment(SuspendDeploymentRequest input)	Suspends a deployment.
TerminateDeploymentResponse	terminateDeployment(TerminateDeploymentRequest input)	Terminates a deployment.
TransitionFlowResponse	transitionFlow(TransitionFlowRequest input)	Deprecated.
UpdateCustomNarConfigurationResponse	updateCustomNarConfiguration(UpdateCustomNarConfigurationRequest input)	Update the custom NAR configuration.
UpdateCustomPythonConfigurationResponse	updateCustomPythonConfiguration(UpdateCustomPythonConfigurationRequest input)	Update the custom Python configuration.
UpdateDeploymentResponse	updateDeployment(UpdateDeploymentRequest input)	Updates a deployment.
UpdateNifiVersionResponse	updateNifiVersion(UpdateNifiVersionRequest input)	Updates the NiFi version of a deployment.
UploadAssetResponse	uploadAsset(UploadAssetRequest input)	Upload an asset.
ValidateCustomNarConfigurationResponse	validateCustomNarConfiguration(ValidateCustomNarConfigurationRequest input)	Validates the custom NAR configuration.
ValidateCustomPythonConfigurationResponse	validateCustomPythonConfiguration(ValidateCustomPythonConfigurationRequest input)	Validates the custom Python configuration.

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 Details

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

• Constant Field Values

Constructor Details

DfworkloadClient

public DfworkloadClient(CdpCredentials credentials,
 String endPoint,
 CdpClientConfiguration clientConfiguration)

DfworkloadClient

public DfworkloadClient(CdpRequestContext<?> context)

Method Details

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

abortAssetUpdateRequest

public AbortAssetUpdateRequestResponse abortAssetUpdateRequest(AbortAssetUpdateRequestRequest input)

Aborts asset update request.

Parameters:

input - Abort Asset Update Request

Returns:

AbortAssetUpdateRequestResponse

abortDeploymentRequest

public AbortDeploymentRequestResponse abortDeploymentRequest(AbortDeploymentRequestRequest input)

Aborts a deployment request.

Parameters:

input - Abort Deployment Request

Returns:

AbortDeploymentRequestResponse

cancelChangeFlowVersion

public CancelChangeFlowVersionResponse cancelChangeFlowVersion(CancelChangeFlowVersionRequest input)

Cancel change flow version for an existing deployment.

Parameters:

input - Cancel Change Flow Version Request

Returns:

CancelChangeFlowVersionResponse

cancelNifiVersionUpdate

public CancelNifiVersionUpdateResponse cancelNifiVersionUpdate(CancelNifiVersionUpdateRequest input)

Cancels a NiFi version update for a deployment.

Parameters:

input - Cancel NiFi Version Update

Returns:

CancelNifiVersionUpdateResponse

changeFlowVersion

public ChangeFlowVersionResponse changeFlowVersion(ChangeFlowVersionRequest input)

Change flow version of a running deployment.

Parameters:

input - Change Flow Version Request

Returns:

ChangeFlowVersionResponse

createAssetUpdateRequest

public CreateAssetUpdateRequestResponse createAssetUpdateRequest(CreateAssetUpdateRequestRequest input)

Create asset update request.

Parameters:

input - Create Asset Update Request

Returns:

CreateAssetUpdateRequestResponse

createCustomNarConfiguration

public CreateCustomNarConfigurationResponse createCustomNarConfiguration(CreateCustomNarConfigurationRequest input)

Create the custom NAR configuration.

Parameters:

input - Create Custom NAR Configuration Request

Returns:

CreateCustomNarConfigurationResponse

createCustomPythonConfiguration

public CreateCustomPythonConfigurationResponse createCustomPythonConfiguration(CreateCustomPythonConfigurationRequest input)

Create the custom Python configuration.

Parameters:

input - Create Custom Python Configuration Request

Returns:

CreateCustomPythonConfigurationResponse

createDeployment

public CreateDeploymentResponse createDeployment(CreateDeploymentRequest input)

Creates a deployment.

Parameters:

input - Create Deployment Request

Returns:

CreateDeploymentResponse

createInboundConnectionEndpoint

public CreateInboundConnectionEndpointResponse createInboundConnectionEndpoint(CreateInboundConnectionEndpointRequest input)

Create Inbound Connection Endpoint

Parameters:

input - Create Inbound Connection Endpoint request

Returns:

CreateInboundConnectionEndpointResponse

createReportingTask

public CreateReportingTaskResponse createReportingTask(CreateReportingTaskRequest input)

Creates a reporting task.

Parameters:

input - Create Reporting Task

Returns:

CreateReportingTaskResponse

deleteCustomNarConfiguration

public DeleteCustomNarConfigurationResponse deleteCustomNarConfiguration(DeleteCustomNarConfigurationRequest input)

Deletes an orphaned custom NAR configuration.

Parameters:

input - Delete Custom NAR Configuration Request

Returns:

DeleteCustomNarConfigurationResponse

deleteCustomPythonConfiguration

public DeleteCustomPythonConfigurationResponse deleteCustomPythonConfiguration(DeleteCustomPythonConfigurationRequest input)

Deletes an orphaned custom Python configuration.

Parameters:

input - Delete Custom Python Configuration Request

Returns:

DeleteCustomPythonConfigurationResponse

deleteInboundConnectionEndpoint

public DeleteInboundConnectionEndpointResponse deleteInboundConnectionEndpoint(DeleteInboundConnectionEndpointRequest input)

Delete Inbound Connection Endpoint

Parameters:

input - Delete Inbound Connection Endpoint request

Returns:

DeleteInboundConnectionEndpointResponse

deleteReportingTask

public DeleteReportingTaskResponse deleteReportingTask(DeleteReportingTaskRequest input)

Deletes a reporting task.

Parameters:

input - Delete Reporting Task

Returns:

DeleteReportingTaskResponse

describeInboundConnectionEndpoint

public DescribeInboundConnectionEndpointResponse describeInboundConnectionEndpoint(DescribeInboundConnectionEndpointRequest input)

Describe Inbound Connection Endpoint

Parameters:

input - Describe Inbound Connection Endpoint request

Returns:

DescribeInboundConnectionEndpointResponse

exportDeployment

public ExportDeploymentResponse exportDeployment(ExportDeploymentRequest input)

Export deployment configuration.

Parameters:

input - Export Deployment Request

Returns:

ExportDeploymentResponse

getClientCertificateEncoded

@Deprecated
public InboundConnectionEndpointClientCertificateResponse getClientCertificateEncoded(InboundConnectionEndpointClientCertificateRequest input)

Deprecated.

Get Inbound Connection Endpoint Client Certificate (in PEM encoding). Deprecated. Use `download-client-certificates-encoded` instead.

Parameters:

input - Get Inbound Connection Endpoint client's certificate request

Returns:

InboundConnectionEndpointClientCertificateResponse

getClientCertificatesEncoded

public InboundConnectionEndpointClientCertificatesResponse getClientCertificatesEncoded(InboundConnectionEndpointClientCertificatesRequest input)

Get Inbound Connection Endpoint Client Certificates (in PEM encoding)

Parameters:

input - Get Inbound Connection Endpoint client's certificates

Returns:

InboundConnectionEndpointClientCertificatesResponse

getClientPrivateKeyEncoded

@Deprecated
public InboundConnectionEndpointClientPrivateKeyResponse getClientPrivateKeyEncoded(InboundConnectionEndpointClientPrivateKeyRequest input)

Deprecated.

Get Inbound Connection Endpoint Client's Private Key (in PEM encoding). Deprecated. Use `download-client-certificates-encoded` instead.

Parameters:

input - Get Inbound Connection Endpoint client's private key request

Returns:

InboundConnectionEndpointClientPrivateKeyResponse

getCustomNarConfiguration

public GetCustomNarConfigurationResponse getCustomNarConfiguration(GetCustomNarConfigurationRequest input)

Get a custom NAR configuration.

Parameters:

input - Get Custom NAR Configuration Request

Returns:

GetCustomNarConfigurationResponse

getCustomPythonConfiguration

public GetCustomPythonConfigurationResponse getCustomPythonConfiguration(GetCustomPythonConfigurationRequest input)

Get a custom Python configuration.

Parameters:

input - Get Custom Python Configuration Request

Returns:

GetCustomPythonConfigurationResponse

getDefaultCustomNarConfiguration

public GetDefaultCustomNarConfigurationResponse getDefaultCustomNarConfiguration(GetDefaultCustomNarConfigurationRequest input)

Get the default custom NAR configuration.

Parameters:

input - Get Default Custom NAR Configuration Request

Returns:

GetDefaultCustomNarConfigurationResponse

getDeploymentConfiguration

public GetDeploymentConfigurationResponse getDeploymentConfiguration(GetDeploymentConfigurationRequest input)

Retrieves the deployment configuration.

Parameters:

input - Get Deployment Configuration Request

Returns:

GetDeploymentConfigurationResponse

getDeploymentConfigurationMetadata

public GetDeploymentConfigurationMetadataResponse getDeploymentConfigurationMetadata(GetDeploymentConfigurationMetadataRequest input)

Retrieves the deployment configuration metadata.

Parameters:

input - Get Deployment Configuration Metadata Request

Returns:

GetDeploymentConfigurationMetadataResponse

getDeploymentRequestDetails

public GetDeploymentRequestDetailsResponse getDeploymentRequestDetails(GetDeploymentRequestDetailsRequest input)

Retrieves deployment request details.

Parameters:

input - Get Deployment Request details

Returns:

GetDeploymentRequestDetailsResponse

importDeployment

public ImportDeploymentResponse importDeployment(ImportDeploymentRequest input)

Import deployment configuration.

Parameters:

input - Import Deployment Configuration Request

Returns:

ImportDeploymentResponse

listDeploymentArchives

public ListDeploymentArchivesResponse listDeploymentArchives(ListDeploymentArchivesRequest input)

Lists the exported archive metadata of all deployments.

Parameters:

input - List Deployment Archives Request

Returns:

ListDeploymentArchivesResponse

listInboundConnectionEndpoints

public ListInboundConnectionEndpointsResponse listInboundConnectionEndpoints(ListInboundConnectionEndpointsRequest input)

List Inbound Connection Endpoints

Parameters:

input - List Inbound Connection Endpoints request

Returns:

ListInboundConnectionEndpointsResponse

listNifiVersions

public ListNifiVersionsResponse listNifiVersions(ListNifiVersionsRequest input)

Lists all supported NiFi versions.

Parameters:

input - List NiFi Versions Request

Returns:

ListNifiVersionsResponse

listReportingTasks

public ListReportingTasksResponse listReportingTasks(ListReportingTasksRequest input)

Lists all reporting tasks for a deployment.

Parameters:

input - List Reporting Tasks Request

Returns:

ListReportingTasksResponse

reassignResources

public ReassignResourcesResponse reassignResources(ReassignResourcesRequest input)

Modifies the project assignment of the given workload resources.

Parameters:

input - Reassign Resources Request

Returns:

ReassignResourcesResponse

renewInboundConnectionEndpointCertificates

public RenewInboundConnectionEndpointCertificateResponse renewInboundConnectionEndpointCertificates(RenewInboundConnectionEndpointCertificateRequest body)

Renew Inbound Connection Endpoint certificates

Parameters:

body - Inbound connection endpoint certificates renewal request

Returns:

RenewInboundConnectionEndpointCertificateResponse

restartDeployment

public RestartDeploymentResponse restartDeployment(RestartDeploymentRequest input)

Restart a deployment.

Parameters:

input - Restart Deployment Request

Returns:

RestartDeploymentResponse

resumeDeployment

public ResumeDeploymentResponse resumeDeployment(ResumeDeploymentRequest input)

Resumes a deployment.

Parameters:

input - Resume Deployment Request

Returns:

ResumeDeploymentResponse

startFlow

public StartFlowResponse startFlow(StartFlowRequest input)

Starts a flow.

Parameters:

input - Start Flow

Returns:

StartFlowResponse

stopFlow

public StopFlowResponse stopFlow(StopFlowRequest input)

Stops a flow.

Parameters:

input - Stop Flow

Returns:

StopFlowResponse

suspendDeployment

public SuspendDeploymentResponse suspendDeployment(SuspendDeploymentRequest input)

Suspends a deployment.

Parameters:

input - Suspend Deployment Request

Returns:

SuspendDeploymentResponse

terminateDeployment

public TerminateDeploymentResponse terminateDeployment(TerminateDeploymentRequest input)

Terminates a deployment.

Parameters:

input - Terminate Deployment Request

Returns:

TerminateDeploymentResponse

transitionFlow

@Deprecated
public TransitionFlowResponse transitionFlow(TransitionFlowRequest input)

Deprecated.

Transitions a flow.

Parameters:

input - Transition Flow

Returns:

TransitionFlowResponse

updateCustomNarConfiguration

public UpdateCustomNarConfigurationResponse updateCustomNarConfiguration(UpdateCustomNarConfigurationRequest input)

Update the custom NAR configuration.

Parameters:

input - Update Custom NAR Configuration Request

Returns:

UpdateCustomNarConfigurationResponse

updateCustomPythonConfiguration

public UpdateCustomPythonConfigurationResponse updateCustomPythonConfiguration(UpdateCustomPythonConfigurationRequest input)

Update the custom Python configuration.

Parameters:

input - Update Custom Python Configuration Request

Returns:

UpdateCustomPythonConfigurationResponse

updateDeployment

public UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest input)

Updates a deployment.

Parameters:

input - Update Deployment Request

Returns:

UpdateDeploymentResponse

updateNifiVersion

public UpdateNifiVersionResponse updateNifiVersion(UpdateNifiVersionRequest input)

Updates the NiFi version of a deployment.

Parameters:

input - Update NiFi Version

Returns:

UpdateNifiVersionResponse

uploadAsset

public UploadAssetResponse uploadAsset(UploadAssetRequest input)

Upload an asset.

Parameters:

input - Upload Asset

Returns:

UploadAssetResponse

validateCustomNarConfiguration

public ValidateCustomNarConfigurationResponse validateCustomNarConfiguration(ValidateCustomNarConfigurationRequest input)

Validates the custom NAR configuration.

Parameters:

input - Validate Custom NAR Configuration Request

Returns:

ValidateCustomNarConfigurationResponse

validateCustomPythonConfiguration

public ValidateCustomPythonConfigurationResponse validateCustomPythonConfiguration(ValidateCustomPythonConfigurationRequest input)

Validates the custom Python configuration.

Parameters:

input - Validate Custom Python Configuration Request

Returns:

ValidateCustomPythonConfigurationResponse