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="2026-06-05T07:54:45.482-07:00")
public class DfworkloadClient
extends CdpClient
-
Field Summary
FieldsFields inherited from class com.cloudera.cdp.client.CdpClient
NO_EXTENSION -
Constructor Summary
ConstructorsConstructorDescriptionDfworkloadClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) DfworkloadClient(CdpRequestContext<?> context) -
Method Summary
Modifier and TypeMethodDescriptionAborts asset update request.Aborts a deployment request.Aborts a flow request in deployment.Adds a flow to an existing deployment.Deprecated.Cancel change flow version for an existing flow deployment.Cancels a NiFi version update for a deployment.Deprecated.Change flow version of a running deployed flow.Create asset update request.Create the custom NAR configuration.Create the custom Python configuration.Creates a deployment.Create Inbound Connection EndpointCreates a new parameter group.Creates a reporting task.Deletes an orphaned custom NAR configuration.Deletes an orphaned custom Python configuration.Deletes flow draft.Delete Inbound Connection EndpointDeletes the parameter group.Deletes a reporting task.Describe Inbound Connection EndpointDescribes the parameter group with the given parameter group CRN.Duplicates the parameter group with the given CRN under the given new name.Export deployment configuration.Get Inbound Connection Endpoint Client Certificates (in PEM encoding)Get a custom NAR configuration.Get a custom Python configuration.Deprecated.Retrieves the deployment configuration.Retrieves the deployment configuration metadata.Retrieves deployment request details and registers the deployment request.Retrieves the deployed flow configuration in a deployment.Retrieves the deployed flow configuration metadata in a deployment.Retrieves flow request details and registers the flow deployment request.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.Import deployment configuration.Import flow deployment configuration.Lists the exported archive metadata of all deployments.Lists flow drafts.List Inbound Connection EndpointsLists all supported NiFi versions.Lists all known parameter groups.Lists all reporting tasks for a deployment.Lists test sessions.Modifies the project assignment of the given workload resources.Renew Inbound Connection Endpoint certificatesRestart a deployment.Restarts test session.Resumes a deployment.Starts all flows in a deployment.startFlow(StartFlowRequest input) Deprecated.Starts a flow in a deployment.Stops all flows in a deployment.stopFlow(StopFlowRequest input) Deprecated.Stops a flow in a deployment.Suspends a deployment.Suspends test session.Terminates a deployment.Terminates a flow in a deployment.Terminates test session.Update the custom NAR configuration.Update the custom Python configuration.Updates a deployment.Updates a flow deployment.Updates the NiFi version of a deployment.Updates the parameter group for the given parameter group CRN.uploadAsset(UploadAssetRequest input) Upload an asset.Uploads a parameter asset.Validates the custom NAR configuration.Validates the custom Python configuration.Methods inherited from class com.cloudera.cdp.client.CdpClient
invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown
-
Field Details
-
SERVICE_NAME
- See Also:
-
-
Constructor Details
-
DfworkloadClient
public DfworkloadClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration) -
DfworkloadClient
-
-
Method Details
-
getServiceName
Description copied from class:CdpClientGets the service name.- Specified by:
getServiceNamein classCdpClient- Returns:
- the service name
-
getRequestContentType
Description copied from class:CdpClientGets the request Content-Type, used by 'Conent-Type' request header.- Overrides:
getRequestContentTypein classCdpClient- Returns:
- the request Content-Type
-
getResponseContentType
Description copied from class:CdpClientGets the expected response Content-Type, used by 'Accept' request header.- Overrides:
getResponseContentTypein classCdpClient- Returns:
- the response Content-Type
-
abortAssetUpdateRequest
public AbortAssetUpdateRequestResponse abortAssetUpdateRequest(AbortAssetUpdateRequestRequest input) Aborts asset update request.- Parameters:
input- Abort Asset Update Request- Returns:
- AbortAssetUpdateRequestResponse
-
abortDeploymentRequest
Aborts a deployment request.- Parameters:
input- Abort Deployment Request- Returns:
- AbortDeploymentRequestResponse
-
abortFlowRequestInDeployment
public AbortFlowRequestInDeploymentResponse abortFlowRequestInDeployment(AbortFlowRequestInDeploymentRequest input) Aborts a flow request in deployment.- Parameters:
input- Abort Flow Request In Deployment- Returns:
- AbortFlowRequestInDeploymentResponse
-
addFlowToDeployment
Adds a flow to an existing deployment.- Parameters:
input- Add Flow to Deployment Request- Returns:
- AddFlowToDeploymentResponse
-
cancelChangeFlowVersion
@Deprecated public CancelChangeFlowVersionResponse cancelChangeFlowVersion(CancelChangeFlowVersionRequest input) Deprecated.Cancel change flow version for an existing deployment. Deprecated, use cancel-change-flow-version-in-deployment.- Parameters:
input- Cancel Change Flow Version Request- Returns:
- CancelChangeFlowVersionResponse
-
cancelChangeFlowVersionInDeployment
public CancelChangeFlowVersionInDeploymentResponse cancelChangeFlowVersionInDeployment(CancelChangeFlowVersionInDeploymentRequest input) Cancel change flow version for an existing flow deployment.- Parameters:
input- Cancel Change Flow Version In Deployment Request- Returns:
- CancelChangeFlowVersionInDeploymentResponse
-
cancelNifiVersionUpdate
public CancelNifiVersionUpdateResponse cancelNifiVersionUpdate(CancelNifiVersionUpdateRequest input) Cancels a NiFi version update for a deployment.- Parameters:
input- Cancel NiFi Version Update- Returns:
- CancelNifiVersionUpdateResponse
-
changeFlowVersion
Deprecated.Change flow version of a running deployment. Deprecated, use change-flow-version-in-deployment.- Parameters:
input- Change Flow Version Request- Returns:
- ChangeFlowVersionResponse
-
changeFlowVersionInDeployment
public ChangeFlowVersionInDeploymentResponse changeFlowVersionInDeployment(ChangeFlowVersionInDeploymentRequest input) Change flow version of a running deployed flow.- Parameters:
input- Change Flow Version In Deployment Request- Returns:
- ChangeFlowVersionInDeploymentResponse
-
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
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
-
createParameterGroup
Creates a new parameter group.- Parameters:
input- Create Parameter Group Request.- Returns:
- CreateParameterGroupResponse
-
createReportingTask
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
-
deleteFlowDraft
Deletes flow draft.- Parameters:
input- Delete Flow Draft Request.- Returns:
- DeleteFlowDraftResponse
-
deleteInboundConnectionEndpoint
public DeleteInboundConnectionEndpointResponse deleteInboundConnectionEndpoint(DeleteInboundConnectionEndpointRequest input) Delete Inbound Connection Endpoint- Parameters:
input- Delete Inbound Connection Endpoint request- Returns:
- DeleteInboundConnectionEndpointResponse
-
deleteParameterGroup
Deletes the parameter group.- Parameters:
input- Delete Parameter Group Request.- Returns:
- DeleteParameterGroupResponse
-
deleteReportingTask
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
-
describeParameterGroup
Describes the parameter group with the given parameter group CRN.- Parameters:
input- Describe Parameter Group Request.- Returns:
- DescribeParameterGroupResponse
-
duplicateParameterGroup
public DuplicateParameterGroupResponse duplicateParameterGroup(DuplicateParameterGroupRequest input) Duplicates the parameter group with the given CRN under the given new name.- Parameters:
input- Duplicate Parameter Group Request.- Returns:
- DuplicateParameterGroupResponse
-
exportDeployment
Export deployment configuration.- Parameters:
input- Export Deployment Request- Returns:
- ExportDeploymentResponse
-
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
-
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
@Deprecated public GetDefaultCustomNarConfigurationResponse getDefaultCustomNarConfiguration(GetDefaultCustomNarConfigurationRequest input) Deprecated.Get the default custom NAR configuration. Deprecated, no longer supported.- 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 and registers the deployment request.- Parameters:
input- Get Deployment Request details- Returns:
- GetDeploymentRequestDetailsResponse
-
getFlowConfigurationInDeployment
public GetFlowConfigurationInDeploymentResponse getFlowConfigurationInDeployment(GetFlowConfigurationInDeploymentRequest input) Retrieves the deployed flow configuration in a deployment.- Parameters:
input- Get Flow Configuration In Deployment Request- Returns:
- GetFlowConfigurationInDeploymentResponse
-
getFlowConfigurationMetadataInDeployment
public GetFlowConfigurationMetadataInDeploymentResponse getFlowConfigurationMetadataInDeployment(GetFlowConfigurationMetadataInDeploymentRequest input) Retrieves the deployed flow configuration metadata in a deployment.- Parameters:
input- Get Flow Configuration Metadata In Deployment Request- Returns:
- GetFlowConfigurationMetadataInDeploymentResponse
-
getFlowRequestDetailsInDeployment
public GetFlowRequestDetailsInDeploymentResponse getFlowRequestDetailsInDeployment(GetFlowDeploymentRequestDetailsRequest input) Retrieves flow request details and registers the flow deployment request.- Parameters:
input- Get Flow Request Details in Deployment- Returns:
- GetFlowRequestDetailsInDeploymentResponse
-
importDeployment
Import deployment configuration.- Parameters:
input- Import Deployment Configuration Request- Returns:
- ImportDeploymentResponse
-
importFlowIntoDeployment
public ImportFlowIntoDeploymentResponse importFlowIntoDeployment(ImportFlowIntoDeploymentRequest input) Import flow deployment configuration.- Parameters:
input- Import Flow Into Deployment Request- Returns:
- ImportFlowIntoDeploymentResponse
-
listDeploymentArchives
Lists the exported archive metadata of all deployments.- Parameters:
input- List Deployment Archives Request- Returns:
- ListDeploymentArchivesResponse
-
listFlowDrafts
Lists flow drafts.- Parameters:
input- List Flow Drafts Request.- Returns:
- ListFlowDraftsResponse
-
listInboundConnectionEndpoints
public ListInboundConnectionEndpointsResponse listInboundConnectionEndpoints(ListInboundConnectionEndpointsRequest input) List Inbound Connection Endpoints- Parameters:
input- List Inbound Connection Endpoints request- Returns:
- ListInboundConnectionEndpointsResponse
-
listNifiVersions
Lists all supported NiFi versions.- Parameters:
input- List NiFi Versions Request- Returns:
- ListNifiVersionsResponse
-
listParameterGroups
Lists all known parameter groups.- Parameters:
input- List Parameter Groups Request.- Returns:
- ListParameterGroupsResponse
-
listReportingTasks
Lists all reporting tasks for a deployment.- Parameters:
input- List Reporting Tasks Request- Returns:
- ListReportingTasksResponse
-
listTestSessions
Lists test sessions.- Parameters:
input- List Test Sessions Request.- Returns:
- ListTestSessionsResponse
-
reassignResources
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
Restart a deployment.- Parameters:
input- Restart Deployment Request- Returns:
- RestartDeploymentResponse
-
restartTestSession
Restarts test session.- Parameters:
input- Restart Test Session Request.- Returns:
- RestartTestSessionResponse
-
resumeDeployment
Resumes a deployment.- Parameters:
input- Resume Deployment Request- Returns:
- ResumeDeploymentResponse
-
startAllFlowsInDeployment
public StartAllFlowsInDeploymentResponse startAllFlowsInDeployment(StartAllFlowsInDeploymentRequest input) Starts all flows in a deployment.- Parameters:
input- Start All Flows In Deployment Request- Returns:
- StartAllFlowsInDeploymentResponse
-
startFlow
Deprecated.Starts a flow. Deprecated, use start-flow-in-deployment.- Parameters:
input- Start Flow- Returns:
- StartFlowResponse
-
startFlowInDeployment
Starts a flow in a deployment.- Parameters:
input- Start Flow In Deployment Request- Returns:
- StartFlowInDeploymentResponse
-
stopAllFlowsInDeployment
public StopAllFlowsInDeploymentResponse stopAllFlowsInDeployment(StopAllFlowsInDeploymentRequest input) Stops all flows in a deployment.- Parameters:
input- Stop All Flows In Deployment Request- Returns:
- StopAllFlowsInDeploymentResponse
-
stopFlow
Deprecated.Stops a flow. Deprecated, use stop-flow-in-deployment.- Parameters:
input- Stop Flow- Returns:
- StopFlowResponse
-
stopFlowInDeployment
Stops a flow in a deployment.- Parameters:
input- Stop Flow In Deployment Request- Returns:
- StopFlowInDeploymentResponse
-
suspendDeployment
Suspends a deployment.- Parameters:
input- Suspend Deployment Request- Returns:
- SuspendDeploymentResponse
-
suspendTestSession
Suspends test session.- Parameters:
input- Suspend Test Session Request.- Returns:
- SuspendTestSessionResponse
-
terminateDeployment
Terminates a deployment.- Parameters:
input- Terminate Deployment Request- Returns:
- TerminateDeploymentResponse
-
terminateFlowInDeployment
public TerminateFlowInDeploymentResponse terminateFlowInDeployment(TerminateFlowInDeploymentRequest input) Terminates a flow in a deployment.- Parameters:
input- Terminate Flow In Deployment Request- Returns:
- TerminateFlowInDeploymentResponse
-
terminateTestSession
Terminates test session.- Parameters:
input- Terminate Test Session Request.- Returns:
- TerminateTestSessionResponse
-
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
Updates a deployment.- Parameters:
input- Update Deployment Request- Returns:
- UpdateDeploymentResponse
-
updateFlowInDeployment
Updates a flow deployment.- Parameters:
input- Update Flow In Deployment Request- Returns:
- UpdateFlowInDeploymentResponse
-
updateNifiVersion
Updates the NiFi version of a deployment.- Parameters:
input- Update NiFi Version- Returns:
- UpdateNifiVersionResponse
-
updateParameterGroup
Updates the parameter group for the given parameter group CRN.- Parameters:
input- Update Parameter Group Request.- Returns:
- UpdateParameterGroupResponse
-
uploadAsset
Upload an asset.- Parameters:
input- Upload Asset- Returns:
- UploadAssetResponse
-
uploadParameterAsset
Uploads a parameter asset.- Parameters:
input- Upload Parameter Asset Request.- Returns:
- UploadParameterAssetResponse
-
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
-