Package com.cloudera.cdp.ml.api

Class MlClient

java.lang.Object

com.cloudera.cdp.client.CdpClient

com.cloudera.cdp.ml.api.MlClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2025-10-15T17:00:45.776-07:00")
public class MlClient
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
MlClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
MlClient(CdpRequestContext<?> context)

Method Summary

Modifier and Type	Method	Description
AddInstanceGroupsResponse	addInstanceGroups(AddInstanceGroupsRequest input)	Add new Cloudera AI workbench cluster instance groups.
AddInstanceGroupsMlServingAppResponse	addInstanceGroupsMlServingApp(AddInstanceGroupsMlServingAppRequest input)	Add instance group to an existing Cloudera AI Inference Service instance.
BackupWorkspaceResponse	backupWorkspace(BackupWorkspaceRequest input)	Backup a Cloudera AI workbench.
CreateFileReplicaResponse	createFileReplica(CreateFileReplicaRequest input)	Create file system replica.
CreateMlServingAppResponse	createMlServingApp(CreateMlServingAppRequest input)	Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
CreateModelRegistryResponse	createModelRegistry(CreateModelRegistryRequest input)	Creates a new model registry.
CreateWorkspaceResponse	createWorkspace(CreateWorkspaceRequest input)	Create a Cloudera AI workbench.
DeleteBackupResponse	deleteBackup(DeleteBackupRequest input)	Deletes a backup snapshot.
DeleteFileReplicaResponse	deleteFileReplica(DeleteFileReplicaRequest input)	Delete existing replication for project files.
DeleteInstanceGroupResponse	deleteInstanceGroup(DeleteInstanceGroupRequest input)	Deletes an instance group from the cluster.
DeleteInstanceGroupMlServingAppResponse	deleteInstanceGroupMlServingApp(DeleteInstanceGroupMlServingAppRequest input)	Deletes an instance group from a Cloudera AI Inference Service instance.
DeleteMlServingAppResponse	deleteMlServingApp(DeleteMlServingAppRequest input)	Deletes Cloudera AI Inference Service instance.
DeleteModelRegistryResponse	deleteModelRegistry(DeleteModelRegistryRequest input)	Deletes a model registry.
DeleteWorkspaceResponse	deleteWorkspace(DeleteWorkspaceRequest input)	Delete Cloudera AI workbench.
DescribeMlServingAppResponse	describeMlServingApp(DescribeMlServingAppRequest input)	Describe Cloudera AI Inference Service instance.
DescribeModelRegistryResponse	describeModelRegistry(DescribeModelRegistryRequest input)	Deprecated: Cloudera AI Model Registry is now deprecated.
DescribeWorkspaceResponse	describeWorkspace(DescribeWorkspaceRequest input)	Describe Cloudera AI workbench.
DescribeWorkspaceBackupResponse	describeWorkspaceBackup(DescribeWorkspaceBackupRequest input)	Describe backup snaphot of a workbench.
FailOverFileSystemResponse	failOverFileSystem(FailOverFileSystemRequest input)	Failover to replica file system
GetAuditEventsResponse	getAuditEvents(GetAuditEventsRequest input)	Gets all the events belong to a workbench crn.
GetKubeconfigResponse	getKubeconfig(GetKubeconfigRequest input)	ListWorkspaceAccess Cloudera AI workbench.
GetLatestModelRegistryVersionResponse	getLatestModelRegistryVersion(GetLatestModelRegistryVersionRequest input)	GetLatestModelRegistryVersion Cloudera AI Registry.
GetLatestWorkspaceVersionResponse	getLatestWorkspaceVersion(GetLatestWorkspaceVersionRequest input)	GetLatestWorkspaceVersion Cloudera AI workbench.
GetLogsResponse	getLogs(GetLogsRequest input)	Gets all the logs belong to a request id.
GetMlServingAppKubeconfigResponse	getMlServingAppKubeconfig(GetMlServingAppKubeconfigRequest input)	Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.
GetModelRegistryKubeconfigResponse	getModelRegistryKubeconfig(GetModelRegistryKubeconfigRequest input)	GetModelRegistryKubeconfig returns kube config for model registry.
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.
GrantMlServingAppAccessResponse	grantMlServingAppAccess(GrantMlServingAppAccessRequest input)	Grants admin access to a Cloudera AI Inference Service cluster.
GrantModelRegistryAccessResponse	grantModelRegistryAccess(GrantModelRegistryAccessRequest input)	GrantModelRegistryAccess Cloudera AI Model Registry.
GrantWorkspaceAccessResponse	grantWorkspaceAccess(GrantWorkspaceAccessRequest input)	GrantWorkspaceAccess Cloudera AI workbench.
ListInstanceTypeConfigurationResponse	listInstanceTypeConfiguration(ListInstanceTypeConfigurationRequest input)	List the instance configuration for a given instance type.
ListMlServingAppAccessResponse	listMlServingAppAccess(ListMlServingAppAccessRequest input)	List members that have Kubernetes access to a Cloudera AI Inference Service cluster.
ListMlServingAppsResponse	listMlServingApps(ListMlServingAppsRequest input)	List all Cloudera AI Inference Service instances.
ListModelRegistriesResponse	listModelRegistries(ListModelRegistriesRequest input)	Lists all model registries.
ListModelRegistryAccessResponse	listModelRegistryAccess(ListModelRegistryAccessRequest input)	ListWorkspaceAccess Cloudera AI Model Registry.
ListRelevantInstancesResponse	listRelevantInstances(ListRelevantInstancesRequest input)	List the instance types for Cloudera AI workbench creation that have the requested resource.
ListWorkspaceAccessResponse	listWorkspaceAccess(ListWorkspaceAccessRequest input)	ListWorkspaceAccess Cloudera AI workbench.
ListWorkspaceBackupsResponse	listWorkspaceBackups(ListWorkspaceBackupsRequest input)	List backup snapshots of a workbench.
ListWorkspacesResponse	listWorkspaces(ListWorkspacesRequest input)	List Cloudera AI workbenches.
ModifyClusterInstanceGroupResponse	modifyClusterInstanceGroup(ModifyClusterInstanceGroupRequest input)	Modify Cloudera AI workbench cluster instance group.
ModifyClusterSecurityResponse	modifyClusterSecurity(ModifyClusterSecurityRequest input)	Modify Cloudera AI workbench cluster security.
ModifyMlServingAppResponse	modifyMlServingApp(ModifyMlServingAppRequest input)	Modify instance groups for a Cloudera AI Inference Service cluster.
ModifyWorkspaceLoadBalancerResponse	modifyWorkspaceLoadBalancer(ModifyWorkspaceLoadBalancerRequest input)	Modify Cloudera AI workbench loadbalancer.
RefreshModelRegistryConfigmapResponse	refreshModelRegistryConfigmap(RefreshModelRegistryConfigmapRequest input)	Refreshes the model registry configmap of the workbench.
RequestWorkflowCancellationResponse	requestWorkflowCancellation(RequestWorkflowCancellationRequest input)	Request a workflow cancellation.
RestoreWorkspaceResponse	restoreWorkspace(RestoreWorkspaceRequest input)	Restore a Cloudera AI workbench.
ResumeWorkspaceResponse	resumeWorkspace(ResumeWorkspaceRequest input)	Resume Cloudera AI workbench.
RevokeMlServingAppAccessResponse	revokeMlServingAppAccess(RevokeMlServingAppAccessRequest input)	Revokes access to a Cloudera AI Inference Service cluster.
RevokeModelRegistryAccessResponse	revokeModelRegistryAccess(RevokeModelRegistryAccessRequest input)	RevokeModelRegistryAccess Cloudera AI Model Registry.
RevokeWorkspaceAccessResponse	revokeWorkspaceAccess(RevokeWorkspaceAccessRequest input)	RevokeWorkspaceAccess Cloudera AI workbench.
RollbackModelRegistryUpgradeResponse	rollbackModelRegistryUpgrade(RollbackModelRegistryUpgradeRequest input)	Rollback a model registry upgrade.
SuspendWorkspaceResponse	suspendWorkspace(SuspendWorkspaceRequest input)	Suspend Cloudera AI workbench.
UpgradeMlServingAppResponse	upgradeMlServingApp(UpgradeMlServingAppRequest input)	Upgrade a Cloudera AI Inference Service instance.
UpgradeModelRegistryResponse	upgradeModelRegistry(UpgradeModelRegistryRequest input)	Upgrade a model registry.
UpgradeWorkspaceResponse	upgradeWorkspace(UpgradeWorkspaceRequest input)	Upgrade Cloudera AI workbench.

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

MlClient

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

MlClient

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

addInstanceGroups

public AddInstanceGroupsResponse addInstanceGroups(AddInstanceGroupsRequest input)

Add new Cloudera AI workbench cluster instance groups.

Parameters:

input -

Returns:

AddInstanceGroupsResponse

addInstanceGroupsMlServingApp

public AddInstanceGroupsMlServingAppResponse addInstanceGroupsMlServingApp(AddInstanceGroupsMlServingAppRequest input)

Add instance group to an existing Cloudera AI Inference Service instance.

Parameters:

input -

Returns:

AddInstanceGroupsMlServingAppResponse

backupWorkspace

public BackupWorkspaceResponse backupWorkspace(BackupWorkspaceRequest input)

Backup a Cloudera AI workbench.

Parameters:

input -

Returns:

BackupWorkspaceResponse

createFileReplica

public CreateFileReplicaResponse createFileReplica(CreateFileReplicaRequest input)

Create file system replica.

Parameters:

input -

Returns:

CreateFileReplicaResponse

createMlServingApp

public CreateMlServingAppResponse createMlServingApp(CreateMlServingAppRequest input)

Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.

Parameters:

input -

Returns:

CreateMlServingAppResponse

createModelRegistry

public CreateModelRegistryResponse createModelRegistry(CreateModelRegistryRequest input)

Creates a new model registry.

Parameters:

input -

Returns:

CreateModelRegistryResponse

createWorkspace

public CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest input)

Create a Cloudera AI workbench.

Parameters:

input -

Returns:

CreateWorkspaceResponse

deleteBackup

public DeleteBackupResponse deleteBackup(DeleteBackupRequest input)

Deletes a backup snapshot.

Parameters:

input -

Returns:

DeleteBackupResponse

deleteFileReplica

public DeleteFileReplicaResponse deleteFileReplica(DeleteFileReplicaRequest input)

Delete existing replication for project files.

Parameters:

input -

Returns:

DeleteFileReplicaResponse

deleteInstanceGroup

public DeleteInstanceGroupResponse deleteInstanceGroup(DeleteInstanceGroupRequest input)

Deletes an instance group from the cluster.

Parameters:

input -

Returns:

DeleteInstanceGroupResponse

deleteInstanceGroupMlServingApp

public DeleteInstanceGroupMlServingAppResponse deleteInstanceGroupMlServingApp(DeleteInstanceGroupMlServingAppRequest input)

Deletes an instance group from a Cloudera AI Inference Service instance.

Parameters:

input -

Returns:

DeleteInstanceGroupMlServingAppResponse

deleteMlServingApp

public DeleteMlServingAppResponse deleteMlServingApp(DeleteMlServingAppRequest input)

Deletes Cloudera AI Inference Service instance.

Parameters:

input -

Returns:

DeleteMlServingAppResponse

deleteModelRegistry

public DeleteModelRegistryResponse deleteModelRegistry(DeleteModelRegistryRequest input)

Deletes a model registry.

Parameters:

input -

Returns:

DeleteModelRegistryResponse

deleteWorkspace

public DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest input)

Delete Cloudera AI workbench.

Parameters:

input -

Returns:

DeleteWorkspaceResponse

describeMlServingApp

public DescribeMlServingAppResponse describeMlServingApp(DescribeMlServingAppRequest input)

Describe Cloudera AI Inference Service instance.

Parameters:

input -

Returns:

DescribeMlServingAppResponse

describeModelRegistry

public DescribeModelRegistryResponse describeModelRegistry(DescribeModelRegistryRequest input)

Deprecated: Cloudera AI Model Registry is now deprecated.

Parameters:

input -

Returns:

DescribeModelRegistryResponse

describeWorkspace

public DescribeWorkspaceResponse describeWorkspace(DescribeWorkspaceRequest input)

Describe Cloudera AI workbench.

Parameters:

input -

Returns:

DescribeWorkspaceResponse

describeWorkspaceBackup

public DescribeWorkspaceBackupResponse describeWorkspaceBackup(DescribeWorkspaceBackupRequest input)

Describe backup snaphot of a workbench.

Parameters:

input -

Returns:

DescribeWorkspaceBackupResponse

failOverFileSystem

public FailOverFileSystemResponse failOverFileSystem(FailOverFileSystemRequest input)

Failover to replica file system

Parameters:

input -

Returns:

FailOverFileSystemResponse

getAuditEvents

public GetAuditEventsResponse getAuditEvents(GetAuditEventsRequest input)

Gets all the events belong to a workbench crn.

Parameters:

input -

Returns:

GetAuditEventsResponse

getKubeconfig

public GetKubeconfigResponse getKubeconfig(GetKubeconfigRequest input)

ListWorkspaceAccess Cloudera AI workbench.

Parameters:

input -

Returns:

GetKubeconfigResponse

getLatestModelRegistryVersion

public GetLatestModelRegistryVersionResponse getLatestModelRegistryVersion(GetLatestModelRegistryVersionRequest input)

GetLatestModelRegistryVersion Cloudera AI Registry.

Parameters:

input -

Returns:

GetLatestModelRegistryVersionResponse

getLatestWorkspaceVersion

public GetLatestWorkspaceVersionResponse getLatestWorkspaceVersion(GetLatestWorkspaceVersionRequest input)

GetLatestWorkspaceVersion Cloudera AI workbench.

Parameters:

input -

Returns:

GetLatestWorkspaceVersionResponse

getLogs

public GetLogsResponse getLogs(GetLogsRequest input)

Gets all the logs belong to a request id.

Parameters:

input -

Returns:

GetLogsResponse

getMlServingAppKubeconfig

public GetMlServingAppKubeconfigResponse getMlServingAppKubeconfig(GetMlServingAppKubeconfigRequest input)

Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.

Parameters:

input -

Returns:

GetMlServingAppKubeconfigResponse

getModelRegistryKubeconfig

public GetModelRegistryKubeconfigResponse getModelRegistryKubeconfig(GetModelRegistryKubeconfigRequest input)

GetModelRegistryKubeconfig returns kube config for model registry.

Parameters:

input -

Returns:

GetModelRegistryKubeconfigResponse

grantMlServingAppAccess

public GrantMlServingAppAccessResponse grantMlServingAppAccess(GrantMlServingAppAccessRequest input)

Grants admin access to a Cloudera AI Inference Service cluster.

Parameters:

input -

Returns:

GrantMlServingAppAccessResponse

grantModelRegistryAccess

public GrantModelRegistryAccessResponse grantModelRegistryAccess(GrantModelRegistryAccessRequest input)

GrantModelRegistryAccess Cloudera AI Model Registry.

Parameters:

input -

Returns:

GrantModelRegistryAccessResponse

grantWorkspaceAccess

public GrantWorkspaceAccessResponse grantWorkspaceAccess(GrantWorkspaceAccessRequest input)

GrantWorkspaceAccess Cloudera AI workbench.

Parameters:

input -

Returns:

GrantWorkspaceAccessResponse

listInstanceTypeConfiguration

public ListInstanceTypeConfigurationResponse listInstanceTypeConfiguration(ListInstanceTypeConfigurationRequest input)

List the instance configuration for a given instance type.

Parameters:

input -

Returns:

ListInstanceTypeConfigurationResponse

listMlServingAppAccess

public ListMlServingAppAccessResponse listMlServingAppAccess(ListMlServingAppAccessRequest input)

List members that have Kubernetes access to a Cloudera AI Inference Service cluster.

Parameters:

input -

Returns:

ListMlServingAppAccessResponse

listMlServingApps

public ListMlServingAppsResponse listMlServingApps(ListMlServingAppsRequest input)

List all Cloudera AI Inference Service instances.

Parameters:

input -

Returns:

ListMlServingAppsResponse

listModelRegistries

public ListModelRegistriesResponse listModelRegistries(ListModelRegistriesRequest input)

Lists all model registries.

Parameters:

input -

Returns:

ListModelRegistriesResponse

listModelRegistryAccess

public ListModelRegistryAccessResponse listModelRegistryAccess(ListModelRegistryAccessRequest input)

ListWorkspaceAccess Cloudera AI Model Registry.

Parameters:

input -

Returns:

ListModelRegistryAccessResponse

listRelevantInstances

public ListRelevantInstancesResponse listRelevantInstances(ListRelevantInstancesRequest input)

List the instance types for Cloudera AI workbench creation that have the requested resource.

Parameters:

input -

Returns:

ListRelevantInstancesResponse

listWorkspaceAccess

public ListWorkspaceAccessResponse listWorkspaceAccess(ListWorkspaceAccessRequest input)

ListWorkspaceAccess Cloudera AI workbench.

Parameters:

input -

Returns:

ListWorkspaceAccessResponse

listWorkspaceBackups

public ListWorkspaceBackupsResponse listWorkspaceBackups(ListWorkspaceBackupsRequest input)

List backup snapshots of a workbench.

Parameters:

input -

Returns:

ListWorkspaceBackupsResponse

listWorkspaces

public ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest input)

List Cloudera AI workbenches.

Parameters:

input -

Returns:

ListWorkspacesResponse

modifyClusterInstanceGroup

public ModifyClusterInstanceGroupResponse modifyClusterInstanceGroup(ModifyClusterInstanceGroupRequest input)

Modify Cloudera AI workbench cluster instance group.

Parameters:

input -

Returns:

ModifyClusterInstanceGroupResponse

modifyClusterSecurity

public ModifyClusterSecurityResponse modifyClusterSecurity(ModifyClusterSecurityRequest input)

Modify Cloudera AI workbench cluster security.

Parameters:

input -

Returns:

ModifyClusterSecurityResponse

modifyMlServingApp

public ModifyMlServingAppResponse modifyMlServingApp(ModifyMlServingAppRequest input)

Modify instance groups for a Cloudera AI Inference Service cluster.

Parameters:

input -

Returns:

ModifyMlServingAppResponse

modifyWorkspaceLoadBalancer

public ModifyWorkspaceLoadBalancerResponse modifyWorkspaceLoadBalancer(ModifyWorkspaceLoadBalancerRequest input)

Modify Cloudera AI workbench loadbalancer.

Parameters:

input -

Returns:

ModifyWorkspaceLoadBalancerResponse

refreshModelRegistryConfigmap

public RefreshModelRegistryConfigmapResponse refreshModelRegistryConfigmap(RefreshModelRegistryConfigmapRequest input)

Refreshes the model registry configmap of the workbench.

Parameters:

input -

Returns:

RefreshModelRegistryConfigmapResponse

requestWorkflowCancellation

public RequestWorkflowCancellationResponse requestWorkflowCancellation(RequestWorkflowCancellationRequest input)

Request a workflow cancellation.

Parameters:

input -

Returns:

RequestWorkflowCancellationResponse

restoreWorkspace

public RestoreWorkspaceResponse restoreWorkspace(RestoreWorkspaceRequest input)

Restore a Cloudera AI workbench.

Parameters:

input -

Returns:

RestoreWorkspaceResponse

resumeWorkspace

public ResumeWorkspaceResponse resumeWorkspace(ResumeWorkspaceRequest input)

Resume Cloudera AI workbench.

Parameters:

input -

Returns:

ResumeWorkspaceResponse

revokeMlServingAppAccess

public RevokeMlServingAppAccessResponse revokeMlServingAppAccess(RevokeMlServingAppAccessRequest input)

Revokes access to a Cloudera AI Inference Service cluster.

Parameters:

input -

Returns:

RevokeMlServingAppAccessResponse

revokeModelRegistryAccess

public RevokeModelRegistryAccessResponse revokeModelRegistryAccess(RevokeModelRegistryAccessRequest input)

RevokeModelRegistryAccess Cloudera AI Model Registry.

Parameters:

input -

Returns:

RevokeModelRegistryAccessResponse

revokeWorkspaceAccess

public RevokeWorkspaceAccessResponse revokeWorkspaceAccess(RevokeWorkspaceAccessRequest input)

RevokeWorkspaceAccess Cloudera AI workbench.

Parameters:

input -

Returns:

RevokeWorkspaceAccessResponse

rollbackModelRegistryUpgrade

public RollbackModelRegistryUpgradeResponse rollbackModelRegistryUpgrade(RollbackModelRegistryUpgradeRequest input)

Rollback a model registry upgrade. Restore prior model registry.

Parameters:

input -

Returns:

RollbackModelRegistryUpgradeResponse

suspendWorkspace

public SuspendWorkspaceResponse suspendWorkspace(SuspendWorkspaceRequest input)

Suspend Cloudera AI workbench.

Parameters:

input -

Returns:

SuspendWorkspaceResponse

upgradeMlServingApp

public UpgradeMlServingAppResponse upgradeMlServingApp(UpgradeMlServingAppRequest input)

Upgrade a Cloudera AI Inference Service instance.

Parameters:

input -

Returns:

UpgradeMlServingAppResponse

upgradeModelRegistry

public UpgradeModelRegistryResponse upgradeModelRegistry(UpgradeModelRegistryRequest input)

Upgrade a model registry.

Parameters:

input -

Returns:

UpgradeModelRegistryResponse

upgradeWorkspace

public UpgradeWorkspaceResponse upgradeWorkspace(UpgradeWorkspaceRequest input)

Upgrade Cloudera AI workbench.

Parameters:

input -

Returns:

UpgradeWorkspaceResponse