java.lang.Object
- com.cloudera.cdp.client.CdpClient
- - com.cloudera.cdp.ml.api.MlClient

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BackupWorkspaceResponse`	`backupWorkspace(BackupWorkspaceRequest input)`	Backup a workspace.
`CreateModelRegistryResponse`	`createModelRegistry(CreateModelRegistryRequest input)`	Creates a new model registry.
`CreateWorkspaceResponse`	`createWorkspace(CreateWorkspaceRequest input)`	Create a Cloudera Machine Learning workspace.
`DeleteBackupResponse`	`deleteBackup(DeleteBackupRequest input)`	Deletes a backup snapshot.
`DeleteInstanceGroupResponse`	`deleteInstanceGroup(DeleteInstanceGroupRequest input)`	Deletes an instance group from the cluster.
`DeleteModelRegistryResponse`	`deleteModelRegistry(DeleteModelRegistryRequest input)`	Deletes a model registry.
`DeleteWorkspaceResponse`	`deleteWorkspace(DeleteWorkspaceRequest input)`	Delete Cloudera Machine Learning Workspace.
`DescribeModelRegistryResponse`	`describeModelRegistry(DescribeModelRegistryRequest input)`	Describe Cloudera Machine Learning Model Registry.
`DescribeWorkspaceResponse`	`describeWorkspace(DescribeWorkspaceRequest input)`	Describe Cloudera Machine Learning Workspace.
`GetAuditEventsResponse`	`getAuditEvents(GetAuditEventsRequest input)`	Gets all the events belong to a workspace crn.
`GetKubeconfigResponse`	`getKubeconfig(GetKubeconfigRequest input)`	ListWorkspaceAccess Cloudera Machine Learning Workspace.
`GetLatestWorkspaceVersionResponse`	`getLatestWorkspaceVersion(GetLatestWorkspaceVersionRequest input)`	GetLatestWorkspaceVersion Cloudera Machine Learning Workspace.
`GetLogsResponse`	`getLogs(GetLogsRequest input)`	Gets all the logs belong to a request id.
`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.
`GrantModelRegistryAccessResponse`	`grantModelRegistryAccess(GrantModelRegistryAccessRequest input)`	GrantModelRegistryAccess Cloudera Machine Learning Model Registry.
`GrantWorkspaceAccessResponse`	`grantWorkspaceAccess(GrantWorkspaceAccessRequest input)`	GrantWorkspaceAccess Cloudera Machine Learning Workspace.
`ListModelRegistriesResponse`	`listModelRegistries(ListModelRegistriesRequest input)`	Lists all model registries.
`ListModelRegistryAccessResponse`	`listModelRegistryAccess(ListModelRegistryAccessRequest input)`	ListWorkspaceAccess Cloudera Machine Learning Model Registry.
`ListWorkspaceAccessResponse`	`listWorkspaceAccess(ListWorkspaceAccessRequest input)`	ListWorkspaceAccess Cloudera Machine Learning Workspace.
`ListWorkspaceBackupsResponse`	`listWorkspaceBackups(ListWorkspaceBackupsRequest input)`	List backup snapshots of a workspace.
`ListWorkspacesResponse`	`listWorkspaces(ListWorkspacesRequest input)`	List Cloudera Machine Learning workspaces.
`ModifyClusterInstanceGroupResponse`	`modifyClusterInstanceGroup(ModifyClusterInstanceGroupRequest input)`	Modify Cloudera Machine Learning workspace cluster instance group.
`ModifyClusterSecurityResponse`	`modifyClusterSecurity(ModifyClusterSecurityRequest input)`	Modify Cloudera Machine Learning workspace cluster security.
`ModifyWorkspaceLoadBalancerResponse`	`modifyWorkspaceLoadBalancer(ModifyWorkspaceLoadBalancerRequest input)`	Modify Cloudera Machine Learning workspace loadbalancer.
`RefreshModelRegistryConfigmapResponse`	`refreshModelRegistryConfigmap(RefreshModelRegistryConfigmapRequest input)`	Refreshes the model registry configmap of the workspace.
`RequestWorkflowCancellationResponse`	`requestWorkflowCancellation(RequestWorkflowCancellationRequest input)`	Request a workflow cancellation.
`RestoreWorkspaceResponse`	`restoreWorkspace(RestoreWorkspaceRequest input)`	Restore a Cloudera Machine Learning workspace.
`ResumeWorkspaceResponse`	`resumeWorkspace(ResumeWorkspaceRequest input)`	Resume Cloudera Machine Learning workspace.
`RevokeModelRegistryAccessResponse`	`revokeModelRegistryAccess(RevokeModelRegistryAccessRequest input)`	RevokeModelRegistryAccess Cloudera Machine Learning Model Registry.
`RevokeWorkspaceAccessResponse`	`revokeWorkspaceAccess(RevokeWorkspaceAccessRequest input)`	RevokeWorkspaceAccess Cloudera Machine Learning Workspace.
`RollbackModelRegistryUpgradeResponse`	`rollbackModelRegistryUpgrade(RollbackModelRegistryUpgradeRequest input)`	Rollback a model registry upgrade.
`SuspendWorkspaceResponse`	`suspendWorkspace(SuspendWorkspaceRequest input)`	Suspend Cloudera Machine Learning workspace.
`UpgradeModelRegistryResponse`	`upgradeModelRegistry(UpgradeModelRegistryRequest input)`	Upgrade a model registry.
`UpgradeWorkspaceResponse`	`upgradeWorkspace(UpgradeWorkspaceRequest input)`	Upgrade Cloudera Machine Learning workspace.

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
  - MlClient
```
public MlClient(CdpCredentials credentials,
                String endPoint,
                CdpClientConfiguration clientConfiguration)
```
  - MlClient
```
public MlClient(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
  - backupWorkspace
```
public BackupWorkspaceResponse backupWorkspace(BackupWorkspaceRequest input)
```
    Backup a workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    BackupWorkspaceResponse
  - createModelRegistry
```
public CreateModelRegistryResponse createModelRegistry(CreateModelRegistryRequest input)
```
    Creates a new model registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateModelRegistryResponse
  - createWorkspace
```
public CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest input)
```
    Create a Cloudera Machine Learning workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateWorkspaceResponse
  - deleteBackup
```
public DeleteBackupResponse deleteBackup(DeleteBackupRequest input)
```
    Deletes a backup snapshot.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteBackupResponse
  - deleteInstanceGroup
```
public DeleteInstanceGroupResponse deleteInstanceGroup(DeleteInstanceGroupRequest input)
```
    Deletes an instance group from the cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteInstanceGroupResponse
  - deleteModelRegistry
```
public DeleteModelRegistryResponse deleteModelRegistry(DeleteModelRegistryRequest input)
```
    Deletes a model registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteModelRegistryResponse
  - deleteWorkspace
```
public DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest input)
```
    Delete Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteWorkspaceResponse
  - describeModelRegistry
```
public DescribeModelRegistryResponse describeModelRegistry(DescribeModelRegistryRequest input)
```
    Describe Cloudera Machine Learning Model Registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeModelRegistryResponse
  - describeWorkspace
```
public DescribeWorkspaceResponse describeWorkspace(DescribeWorkspaceRequest input)
```
    Describe Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeWorkspaceResponse
  - getAuditEvents
```
public GetAuditEventsResponse getAuditEvents(GetAuditEventsRequest input)
```
    Gets all the events belong to a workspace crn.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetAuditEventsResponse
  - getKubeconfig
```
public GetKubeconfigResponse getKubeconfig(GetKubeconfigRequest input)
```
    ListWorkspaceAccess Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetKubeconfigResponse
  - getLatestWorkspaceVersion
```
public GetLatestWorkspaceVersionResponse getLatestWorkspaceVersion(GetLatestWorkspaceVersionRequest input)
```
    GetLatestWorkspaceVersion Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetLatestWorkspaceVersionResponse
  - getLogs
```
public GetLogsResponse getLogs(GetLogsRequest input)
```
    Gets all the logs belong to a request id.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetLogsResponse
  - getModelRegistryKubeconfig
```
public GetModelRegistryKubeconfigResponse getModelRegistryKubeconfig(GetModelRegistryKubeconfigRequest input)
```
    GetModelRegistryKubeconfig returns kube config for model registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetModelRegistryKubeconfigResponse
  - grantModelRegistryAccess
```
public GrantModelRegistryAccessResponse grantModelRegistryAccess(GrantModelRegistryAccessRequest input)
```
    GrantModelRegistryAccess Cloudera Machine Learning Model Registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    GrantModelRegistryAccessResponse
  - grantWorkspaceAccess
```
public GrantWorkspaceAccessResponse grantWorkspaceAccess(GrantWorkspaceAccessRequest input)
```
    GrantWorkspaceAccess Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    GrantWorkspaceAccessResponse
  - listModelRegistries
```
public ListModelRegistriesResponse listModelRegistries(ListModelRegistriesRequest input)
```
    Lists all model registries.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListModelRegistriesResponse
  - listModelRegistryAccess
```
public ListModelRegistryAccessResponse listModelRegistryAccess(ListModelRegistryAccessRequest input)
```
    ListWorkspaceAccess Cloudera Machine Learning Model Registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListModelRegistryAccessResponse
  - listWorkspaceAccess
```
public ListWorkspaceAccessResponse listWorkspaceAccess(ListWorkspaceAccessRequest input)
```
    ListWorkspaceAccess Cloudera Machine Learning Workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListWorkspaceAccessResponse
  - listWorkspaceBackups
```
public ListWorkspaceBackupsResponse listWorkspaceBackups(ListWorkspaceBackupsRequest input)
```
    List backup snapshots of a workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListWorkspaceBackupsResponse
  - listWorkspaces
```
public ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest input)
```
    List Cloudera Machine Learning workspaces.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListWorkspacesResponse
  - modifyClusterInstanceGroup
```
public ModifyClusterInstanceGroupResponse modifyClusterInstanceGroup(ModifyClusterInstanceGroupRequest input)
```
    Modify Cloudera Machine Learning workspace cluster instance group.
    
    Parameters:
    
    input -
    
    Returns:
    
    ModifyClusterInstanceGroupResponse
  - modifyClusterSecurity
```
public ModifyClusterSecurityResponse modifyClusterSecurity(ModifyClusterSecurityRequest input)
```
    Modify Cloudera Machine Learning workspace cluster security.
    
    Parameters:
    
    input -
    
    Returns:
    
    ModifyClusterSecurityResponse
  - modifyWorkspaceLoadBalancer
```
public ModifyWorkspaceLoadBalancerResponse modifyWorkspaceLoadBalancer(ModifyWorkspaceLoadBalancerRequest input)
```
    Modify Cloudera Machine Learning workspace loadbalancer.
    
    Parameters:
    
    input -
    
    Returns:
    
    ModifyWorkspaceLoadBalancerResponse
  - refreshModelRegistryConfigmap
```
public RefreshModelRegistryConfigmapResponse refreshModelRegistryConfigmap(RefreshModelRegistryConfigmapRequest input)
```
    Refreshes the model registry configmap of the workspace.
    
    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 Machine Learning workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    RestoreWorkspaceResponse
  - resumeWorkspace
```
public ResumeWorkspaceResponse resumeWorkspace(ResumeWorkspaceRequest input)
```
    Resume Cloudera Machine Learning workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    ResumeWorkspaceResponse
  - revokeModelRegistryAccess
```
public RevokeModelRegistryAccessResponse revokeModelRegistryAccess(RevokeModelRegistryAccessRequest input)
```
    RevokeModelRegistryAccess Cloudera Machine Learning Model Registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    RevokeModelRegistryAccessResponse
  - revokeWorkspaceAccess
```
public RevokeWorkspaceAccessResponse revokeWorkspaceAccess(RevokeWorkspaceAccessRequest input)
```
    RevokeWorkspaceAccess Cloudera Machine Learning Workspace.
    
    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 Machine Learning workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    SuspendWorkspaceResponse
  - upgradeModelRegistry
```
public UpgradeModelRegistryResponse upgradeModelRegistry(UpgradeModelRegistryRequest input)
```
    Upgrade a model registry.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeModelRegistryResponse
  - upgradeWorkspace
```
public UpgradeWorkspaceResponse upgradeWorkspace(UpgradeWorkspaceRequest input)
```
    Upgrade Cloudera Machine Learning workspace.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeWorkspaceResponse

Class MlClient

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

MlClient

MlClient

Method Detail

getServiceName

getRequestContentType

getResponseContentType

backupWorkspace

createModelRegistry

createWorkspace

deleteBackup

deleteInstanceGroup

deleteModelRegistry

deleteWorkspace

describeModelRegistry

describeWorkspace

getAuditEvents

getKubeconfig

getLatestWorkspaceVersion

getLogs

getModelRegistryKubeconfig

grantModelRegistryAccess

grantWorkspaceAccess

listModelRegistries

listModelRegistryAccess

listWorkspaceAccess

listWorkspaceBackups

listWorkspaces

modifyClusterInstanceGroup

modifyClusterSecurity

modifyWorkspaceLoadBalancer

refreshModelRegistryConfigmap

requestWorkflowCancellation

restoreWorkspace

resumeWorkspace

revokeModelRegistryAccess

revokeWorkspaceAccess

rollbackModelRegistryUpgrade

suspendWorkspace

upgradeModelRegistry

upgradeWorkspace