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="2023-09-14T10:47:19.979-07:00")
public class DfworkloadClient
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
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.
CancelNifiVersionUpdateResponse	cancelNifiVersionUpdate(CancelNifiVersionUpdateRequest input)	Cancels a NiFi version update for a deployment.
CreateAssetUpdateRequestResponse	createAssetUpdateRequest(CreateAssetUpdateRequestRequest input)	Create asset update request.
CreateCustomNarConfigurationResponse	createCustomNarConfiguration(CreateCustomNarConfigurationRequest input)	Create the custom NAR configuration.
CreateDeploymentResponse	createDeployment(CreateDeploymentRequest input)	Creates a deployment.
CreateInboundConnectionEndpointResponse	createInboundConnectionEndpoint(CreateInboundConnectionEndpointRequest input)	Create Inbound Connection Endpoint
DeleteCustomNarConfigurationResponse	deleteCustomNarConfiguration(DeleteCustomNarConfigurationRequest input)	Deletes an orphaned custom NAR configuration.
DeleteInboundConnectionEndpointResponse	deleteInboundConnectionEndpoint(DeleteInboundConnectionEndpointRequest input)	Delete Inbound Connection Endpoint
DescribeInboundConnectionEndpointResponse	describeInboundConnectionEndpoint(DescribeInboundConnectionEndpointRequest input)	Describe Inbound Connection Endpoint
InboundConnectionEndpointClientCertificateResponse	getClientCertificateEncoded(InboundConnectionEndpointClientCertificateRequest input)	Get Inbound Connection Endpoint Client Certificate (in PEM encoding)
InboundConnectionEndpointClientPrivateKeyResponse	getClientPrivateKeyEncoded(InboundConnectionEndpointClientPrivateKeyRequest input)	Get Inbound Connection Endpoint Client's Private Key (in PEM encoding)
GetCustomNarConfigurationResponse	getCustomNarConfiguration(GetCustomNarConfigurationRequest input)	Get a custom NAR 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.
ListInboundConnectionEndpointsResponse	listInboundConnectionEndpoints(ListInboundConnectionEndpointsRequest input)	List Inbound Connection Endpoints
ListNifiVersionsResponse	listNifiVersions(ListNifiVersionsRequest input)	Lists all supported NiFi versions.
RenewInboundConnectionEndpointCertificateResponse	renewInboundConnectionEndpointCertificates(RenewInboundConnectionEndpointCertificateRequest body)	Renew Inbound Connection Endpoint certificates
TerminateDeploymentResponse	terminateDeployment(TerminateDeploymentRequest input)	Terminates a deployment.
TransitionFlowResponse	transitionFlow(TransitionFlowRequest input)	Transitions a flow.
UpdateCustomNarConfigurationResponse	updateCustomNarConfiguration(UpdateCustomNarConfigurationRequest input)	Update the custom NAR 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.

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

DfworkloadClient

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

DfworkloadClient

public DfworkloadClient(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

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

cancelNifiVersionUpdate

public CancelNifiVersionUpdateResponse cancelNifiVersionUpdate(CancelNifiVersionUpdateRequest input)

Cancels a NiFi version update for a deployment.

Parameters:

input - Cancel NiFi Version Update

Returns:

CancelNifiVersionUpdateResponse

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

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

deleteCustomNarConfiguration

public DeleteCustomNarConfigurationResponse deleteCustomNarConfiguration(DeleteCustomNarConfigurationRequest input)

Deletes an orphaned custom NAR configuration.

Parameters:

input - Delete Custom NAR Configuration Request

Returns:

DeleteCustomNarConfigurationResponse

deleteInboundConnectionEndpoint

public DeleteInboundConnectionEndpointResponse deleteInboundConnectionEndpoint(DeleteInboundConnectionEndpointRequest input)

Delete Inbound Connection Endpoint

Parameters:

input - Delete Inbound Connection Endpoint request

Returns:

DeleteInboundConnectionEndpointResponse

describeInboundConnectionEndpoint

public DescribeInboundConnectionEndpointResponse describeInboundConnectionEndpoint(DescribeInboundConnectionEndpointRequest input)

Describe Inbound Connection Endpoint

Parameters:

input - Describe Inbound Connection Endpoint request

Returns:

DescribeInboundConnectionEndpointResponse

getClientCertificateEncoded

public InboundConnectionEndpointClientCertificateResponse getClientCertificateEncoded(InboundConnectionEndpointClientCertificateRequest input)

Get Inbound Connection Endpoint Client Certificate (in PEM encoding)

Parameters:

input - Get Inbound Connection Endpoint client's certificate request

Returns:

InboundConnectionEndpointClientCertificateResponse

getClientPrivateKeyEncoded

public InboundConnectionEndpointClientPrivateKeyResponse getClientPrivateKeyEncoded(InboundConnectionEndpointClientPrivateKeyRequest input)

Get Inbound Connection Endpoint Client's Private Key (in PEM encoding)

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

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

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

renewInboundConnectionEndpointCertificates

public RenewInboundConnectionEndpointCertificateResponse renewInboundConnectionEndpointCertificates(RenewInboundConnectionEndpointCertificateRequest body)

Renew Inbound Connection Endpoint certificates

Parameters:

body - Inbound connection endpoint certificates renewal request

Returns:

RenewInboundConnectionEndpointCertificateResponse

terminateDeployment

public TerminateDeploymentResponse terminateDeployment(TerminateDeploymentRequest input)

Terminates a deployment.

Parameters:

input - Terminate Deployment Request

Returns:

TerminateDeploymentResponse

transitionFlow

public TransitionFlowResponse transitionFlow(TransitionFlowRequest input)

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

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