Class DataScienceClient

Service client instance for DataScience.

Inheritance
object
ClientBase
RegionalClientBase
DataScienceClient
Implements
Inherited Members
Namespace: Oci.DatascienceService
Assembly: OCI.DotNetSDK.Datascience.dll
Syntax
public class DataScienceClient : RegionalClientBase, IDisposable

Constructors

DataScienceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public DataScienceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.
ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.
string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public DataSciencePaginators Paginators { get; }
Property Value
Type Description
DataSciencePaginators

Waiters

Declaration
public DataScienceWaiters Waiters { get; }
Property Value
Type Description
DataScienceWaiters

Methods

ActivateModel(ActivateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activates the model.

Declaration
public Task<ActivateModelResponse> ActivateModel(ActivateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ActivateModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ActivateModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ActivateModel API.

ActivateModelDeployment(ActivateModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activates the model deployment.

Declaration
public Task<ActivateModelDeploymentResponse> ActivateModelDeployment(ActivateModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ActivateModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ActivateModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ActivateModelDeployment API.

ActivateNotebookSession(ActivateNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activates the notebook session.

Declaration
public Task<ActivateNotebookSessionResponse> ActivateNotebookSession(ActivateNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ActivateNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ActivateNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ActivateNotebookSession API.

CancelJobRun(CancelJobRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels an IN_PROGRESS job run.

Declaration
public Task<CancelJobRunResponse> CancelJobRun(CancelJobRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelJobRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CancelJobRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CancelJobRun API.

CancelPipelineRun(CancelPipelineRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel a PipelineRun.

Declaration
public Task<CancelPipelineRunResponse> CancelPipelineRun(CancelPipelineRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelPipelineRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CancelPipelineRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CancelPipelineRun API.

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a work request that has not started.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CancelWorkRequestResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CancelWorkRequest API.

ChangeDataSciencePrivateEndpointCompartment(ChangeDataSciencePrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeDataSciencePrivateEndpointCompartmentResponse> ChangeDataSciencePrivateEndpointCompartment(ChangeDataSciencePrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeDataSciencePrivateEndpointCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeDataSciencePrivateEndpointCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeDataSciencePrivateEndpointCompartment API.

ChangeJobCompartment(ChangeJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Changes a job's compartment

Declaration
public Task<ChangeJobCompartmentResponse> ChangeJobCompartment(ChangeJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeJobCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeJobCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeJobCompartment API.

ChangeJobRunCompartment(ChangeJobRunCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Changes a job run's compartment

Declaration
public Task<ChangeJobRunCompartmentResponse> ChangeJobRunCompartment(ChangeJobRunCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeJobRunCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeJobRunCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeJobRunCompartment API.

ChangeModelCompartment(ChangeModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a model resource into a different compartment.

Declaration
public Task<ChangeModelCompartmentResponse> ChangeModelCompartment(ChangeModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeModelCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeModelCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeModelCompartment API.

ChangeModelDeploymentCompartment(ChangeModelDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeModelDeploymentCompartmentResponse> ChangeModelDeploymentCompartment(ChangeModelDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeModelDeploymentCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeModelDeploymentCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeModelDeploymentCompartment API.

ChangeModelVersionSetCompartment(ChangeModelVersionSetCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a modelVersionSet resource into a different compartment.

Declaration
public Task<ChangeModelVersionSetCompartmentResponse> ChangeModelVersionSetCompartment(ChangeModelVersionSetCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeModelVersionSetCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeModelVersionSetCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeModelVersionSetCompartment API.

ChangeNotebookSessionCompartment(ChangeNotebookSessionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a notebook session resource into a different compartment.

Declaration
public Task<ChangeNotebookSessionCompartmentResponse> ChangeNotebookSessionCompartment(ChangeNotebookSessionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeNotebookSessionCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeNotebookSessionCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeNotebookSessionCompartment API.

ChangePipelineCompartment(ChangePipelineCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangePipelineCompartmentResponse> ChangePipelineCompartment(ChangePipelineCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangePipelineCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangePipelineCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangePipelineCompartment API.

ChangePipelineRunCompartment(ChangePipelineRunCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangePipelineRunCompartmentResponse> ChangePipelineRunCompartment(ChangePipelineRunCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangePipelineRunCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangePipelineRunCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangePipelineRunCompartment API.

ChangeProjectCompartment(ChangeProjectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a project resource into a different compartment.

Declaration
public Task<ChangeProjectCompartmentResponse> ChangeProjectCompartment(ChangeProjectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeProjectCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeProjectCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeProjectCompartment API.

CreateDataSciencePrivateEndpoint(CreateDataSciencePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a Data Science private endpoint to be used by a Data Science resource.

Declaration
public Task<CreateDataSciencePrivateEndpointResponse> CreateDataSciencePrivateEndpoint(CreateDataSciencePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDataSciencePrivateEndpointRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateDataSciencePrivateEndpointResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateDataSciencePrivateEndpoint API.

CreateJob(CreateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a job.

Declaration
public Task<CreateJobResponse> CreateJob(CreateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateJobRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateJobResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateJob API.

CreateJobArtifact(CreateJobArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Uploads a job artifact.

Declaration
public Task<CreateJobArtifactResponse> CreateJobArtifact(CreateJobArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateJobArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateJobArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateJobArtifact API.

CreateJobRun(CreateJobRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a job run.

Declaration
public Task<CreateJobRunResponse> CreateJobRun(CreateJobRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateJobRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateJobRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateJobRun API.

CreateModel(CreateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new model.

Declaration
public Task<CreateModelResponse> CreateModel(CreateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateModel API.

CreateModelArtifact(CreateModelArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates model artifact for specified model.

Declaration
public Task<CreateModelArtifactResponse> CreateModelArtifact(CreateModelArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateModelArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateModelArtifact API.

CreateModelDeployment(CreateModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new model deployment.

Declaration
public Task<CreateModelDeploymentResponse> CreateModelDeployment(CreateModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateModelDeployment API.

CreateModelProvenance(CreateModelProvenanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates provenance information for the specified model.

Declaration
public Task<CreateModelProvenanceResponse> CreateModelProvenance(CreateModelProvenanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelProvenanceRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateModelProvenanceResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateModelProvenance API.

CreateModelVersionSet(CreateModelVersionSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new modelVersionSet.

Declaration
public Task<CreateModelVersionSetResponse> CreateModelVersionSet(CreateModelVersionSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateModelVersionSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateModelVersionSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateModelVersionSet API.

CreateNotebookSession(CreateNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new notebook session.

Declaration
public Task<CreateNotebookSessionResponse> CreateNotebookSession(CreateNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateNotebookSession API.

CreatePipeline(CreatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Pipeline.

Declaration
public Task<CreatePipelineResponse> CreatePipeline(CreatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreatePipelineRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreatePipelineResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreatePipeline API.

CreatePipelineRun(CreatePipelineRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new PipelineRun.

Declaration
public Task<CreatePipelineRunResponse> CreatePipelineRun(CreatePipelineRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreatePipelineRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreatePipelineRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreatePipelineRun API.

CreateProject(CreateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new project.

Declaration
public Task<CreateProjectResponse> CreateProject(CreateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateProjectRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateProjectResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateProject API.

CreateStepArtifact(CreateStepArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Upload the artifact for a step in the pipeline.

Declaration
public Task<CreateStepArtifactResponse> CreateStepArtifact(CreateStepArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateStepArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateStepArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateStepArtifact API.

DeactivateModel(DeactivateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deactivates the model.

Declaration
public Task<DeactivateModelResponse> DeactivateModel(DeactivateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeactivateModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeactivateModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeactivateModel API.

DeactivateModelDeployment(DeactivateModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deactivates the model deployment.

Declaration
public Task<DeactivateModelDeploymentResponse> DeactivateModelDeployment(DeactivateModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeactivateModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeactivateModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeactivateModelDeployment API.

DeactivateNotebookSession(DeactivateNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deactivates the notebook session.

Declaration
public Task<DeactivateNotebookSessionResponse> DeactivateNotebookSession(DeactivateNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeactivateNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeactivateNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeactivateNotebookSession API.

DeleteDataSciencePrivateEndpoint(DeleteDataSciencePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a private endpoint using privateEndpointId.

Declaration
public Task<DeleteDataSciencePrivateEndpointResponse> DeleteDataSciencePrivateEndpoint(DeleteDataSciencePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDataSciencePrivateEndpointRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteDataSciencePrivateEndpointResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteDataSciencePrivateEndpoint API.

DeleteJob(DeleteJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a job.

Declaration
public Task<DeleteJobResponse> DeleteJob(DeleteJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteJobRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteJobResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteJob API.

DeleteJobRun(DeleteJobRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a job run.

Declaration
public Task<DeleteJobRunResponse> DeleteJobRun(DeleteJobRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteJobRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteJobRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteJobRun API.

DeleteModel(DeleteModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified model.

Declaration
public Task<DeleteModelResponse> DeleteModel(DeleteModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteModel API.

DeleteModelDeployment(DeleteModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified model deployment. Any unsaved work in this model deployment is lost.

Declaration
public Task<DeleteModelDeploymentResponse> DeleteModelDeployment(DeleteModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteModelDeployment API.

DeleteModelVersionSet(DeleteModelVersionSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified modelVersionSet.

Declaration
public Task<DeleteModelVersionSetResponse> DeleteModelVersionSet(DeleteModelVersionSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteModelVersionSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteModelVersionSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteModelVersionSet API.

DeleteNotebookSession(DeleteNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified notebook session. Any unsaved work in this notebook session are lost.

Declaration
public Task<DeleteNotebookSessionResponse> DeleteNotebookSession(DeleteNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteNotebookSession API.

DeletePipeline(DeletePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Pipeline resource by identifier.

Declaration
public Task<DeletePipelineResponse> DeletePipeline(DeletePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeletePipelineRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeletePipelineResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeletePipeline API.

DeletePipelineRun(DeletePipelineRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a PipelineRun resource by identifier.

Declaration
public Task<DeletePipelineRunResponse> DeletePipelineRun(DeletePipelineRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeletePipelineRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeletePipelineRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeletePipelineRun API.

DeleteProject(DeleteProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.

Declaration
public Task<DeleteProjectResponse> DeleteProject(DeleteProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteProjectRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteProjectResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteProject API.

ExportModelArtifact(ExportModelArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Export model artifact from source to the service bucket

Declaration
public Task<ExportModelArtifactResponse> ExportModelArtifact(ExportModelArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ExportModelArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ExportModelArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ExportModelArtifact API.

GetDataSciencePrivateEndpoint(GetDataSciencePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an private endpoint using a privateEndpointId.

Declaration
public Task<GetDataSciencePrivateEndpointResponse> GetDataSciencePrivateEndpoint(GetDataSciencePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDataSciencePrivateEndpointRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetDataSciencePrivateEndpointResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetDataSciencePrivateEndpoint API.

GetJob(GetJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a job.

Declaration
public Task<GetJobResponse> GetJob(GetJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetJobRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetJobResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetJob API.

GetJobArtifactContent(GetJobArtifactContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads job artifact content for specified job.

Declaration
public Task<GetJobArtifactContentResponse> GetJobArtifactContent(GetJobArtifactContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetJobArtifactContentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetJobArtifactContentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetJobArtifactContent API.

GetJobRun(GetJobRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a job run.

Declaration
public Task<GetJobRunResponse> GetJobRun(GetJobRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetJobRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetJobRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetJobRun API.

GetModel(GetModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified model's information.

Declaration
public Task<GetModelResponse> GetModel(GetModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetModel API.

GetModelArtifactContent(GetModelArtifactContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads model artifact content for specified model.

Declaration
public Task<GetModelArtifactContentResponse> GetModelArtifactContent(GetModelArtifactContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelArtifactContentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetModelArtifactContentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetModelArtifactContent API.

GetModelDeployment(GetModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the model deployment for the specified modelDeploymentId.

Declaration
public Task<GetModelDeploymentResponse> GetModelDeployment(GetModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetModelDeployment API.

GetModelProvenance(GetModelProvenanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets provenance information for specified model.

Declaration
public Task<GetModelProvenanceResponse> GetModelProvenance(GetModelProvenanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelProvenanceRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetModelProvenanceResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetModelProvenance API.

GetModelVersionSet(GetModelVersionSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified model version set information.

Declaration
public Task<GetModelVersionSetResponse> GetModelVersionSet(GetModelVersionSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModelVersionSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetModelVersionSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetModelVersionSet API.

GetNotebookSession(GetNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified notebook session's information.

Declaration
public Task<GetNotebookSessionResponse> GetNotebookSession(GetNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetNotebookSession API.

GetPipeline(GetPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a Pipeline by identifier.

Declaration
public Task<GetPipelineResponse> GetPipeline(GetPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetPipelineRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetPipelineResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetPipeline API.

GetPipelineRun(GetPipelineRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a PipelineRun by identifier.

Declaration
public Task<GetPipelineRunResponse> GetPipelineRun(GetPipelineRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetPipelineRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetPipelineRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetPipelineRun API.

GetProject(GetProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified project's information.

Declaration
public Task<GetProjectResponse> GetProject(GetProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetProjectRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetProjectResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetProject API.

GetStepArtifactContent(GetStepArtifactContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Download the artifact for a step in the pipeline.

Declaration
public Task<GetStepArtifactContentResponse> GetStepArtifactContent(GetStepArtifactContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetStepArtifactContentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetStepArtifactContentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetStepArtifactContent API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified work request's information.

Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkRequestRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetWorkRequestResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetWorkRequest API.

HeadJobArtifact(HeadJobArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets job artifact metadata.

Declaration
public Task<HeadJobArtifactResponse> HeadJobArtifact(HeadJobArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
HeadJobArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<HeadJobArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use HeadJobArtifact API.

HeadModelArtifact(HeadModelArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets model artifact metadata for specified model.

Declaration
public Task<HeadModelArtifactResponse> HeadModelArtifact(HeadModelArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
HeadModelArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<HeadModelArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use HeadModelArtifact API.

HeadStepArtifact(HeadStepArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the artifact metadata for a step in the pipeline.

Declaration
public Task<HeadStepArtifactResponse> HeadStepArtifact(HeadStepArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
HeadStepArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<HeadStepArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use HeadStepArtifact API.

ImportModelArtifact(ImportModelArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Import model artifact from service bucket

Declaration
public Task<ImportModelArtifactResponse> ImportModelArtifact(ImportModelArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ImportModelArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ImportModelArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ImportModelArtifact API.

ListDataSciencePrivateEndpoints(ListDataSciencePrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn't include compartmentId, or includes compartmentId with two or more other parameters, then an error is returned.

Declaration
public Task<ListDataSciencePrivateEndpointsResponse> ListDataSciencePrivateEndpoints(ListDataSciencePrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDataSciencePrivateEndpointsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListDataSciencePrivateEndpointsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListDataSciencePrivateEndpoints API.

ListFastLaunchJobConfigs(ListFastLaunchJobConfigsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List fast launch capable job configs in the specified compartment.

Declaration
public Task<ListFastLaunchJobConfigsResponse> ListFastLaunchJobConfigs(ListFastLaunchJobConfigsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListFastLaunchJobConfigsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListFastLaunchJobConfigsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListFastLaunchJobConfigs API.

ListJobRuns(ListJobRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List out job runs.

Declaration
public Task<ListJobRunsResponse> ListJobRuns(ListJobRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListJobRunsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListJobRunsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListJobRuns API.

ListJobShapes(ListJobShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List job shapes available in the specified compartment.

Declaration
public Task<ListJobShapesResponse> ListJobShapes(ListJobShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListJobShapesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListJobShapesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListJobShapes API.

ListJobs(ListJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List jobs in the specified compartment.

Declaration
public Task<ListJobsResponse> ListJobs(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListJobsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListJobsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListJobs API.

ListModelDeploymentShapes(ListModelDeploymentShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the valid model deployment shapes.

Declaration
public Task<ListModelDeploymentShapesResponse> ListModelDeploymentShapes(ListModelDeploymentShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModelDeploymentShapesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListModelDeploymentShapesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListModelDeploymentShapes API.

ListModelDeployments(ListModelDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Declaration
public Task<ListModelDeploymentsResponse> ListModelDeployments(ListModelDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModelDeploymentsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListModelDeploymentsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListModelDeployments API.

ListModelVersionSets(ListModelVersionSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists model version sets in the specified compartment.

Declaration
public Task<ListModelVersionSetsResponse> ListModelVersionSets(ListModelVersionSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModelVersionSetsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListModelVersionSetsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListModelVersionSets API.

ListModels(ListModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists models in the specified compartment.

Declaration
public Task<ListModelsResponse> ListModels(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModelsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListModelsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListModels API.

ListNotebookSessionShapes(ListNotebookSessionShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the valid notebook session shapes.

Declaration
public Task<ListNotebookSessionShapesResponse> ListNotebookSessionShapes(ListNotebookSessionShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListNotebookSessionShapesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListNotebookSessionShapesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListNotebookSessionShapes API.

ListNotebookSessions(ListNotebookSessionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the notebook sessions in the specified compartment.

Declaration
public Task<ListNotebookSessionsResponse> ListNotebookSessions(ListNotebookSessionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListNotebookSessionsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListNotebookSessionsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListNotebookSessions API.

ListPipelineRuns(ListPipelineRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of PipelineRuns.

Declaration
public Task<ListPipelineRunsResponse> ListPipelineRuns(ListPipelineRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPipelineRunsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListPipelineRunsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListPipelineRuns API.

ListPipelines(ListPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Pipelines.

Declaration
public Task<ListPipelinesResponse> ListPipelines(ListPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPipelinesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListPipelinesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListPipelines API.

ListProjects(ListProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists projects in the specified compartment.

Declaration
public Task<ListProjectsResponse> ListProjects(ListProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListProjectsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListProjectsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListProjects API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work request errors for the specified work request.

Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListWorkRequestErrorsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work request logs for the specified work request.

Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListWorkRequestLogsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work requests in the specified compartment.

Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListWorkRequestsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListWorkRequests API.

RestoreArchivedModelArtifact(RestoreArchivedModelArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restore archived model artifact

Declaration
public Task<RestoreArchivedModelArtifactResponse> RestoreArchivedModelArtifact(RestoreArchivedModelArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RestoreArchivedModelArtifactRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<RestoreArchivedModelArtifactResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use RestoreArchivedModelArtifact API.

UpdateDataSciencePrivateEndpoint(UpdateDataSciencePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a private endpoint using a privateEndpointId. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code is returned. This indicates that a conflict has been detected.

Declaration
public Task<UpdateDataSciencePrivateEndpointResponse> UpdateDataSciencePrivateEndpoint(UpdateDataSciencePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDataSciencePrivateEndpointRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateDataSciencePrivateEndpointResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateDataSciencePrivateEndpoint API.

UpdateJob(UpdateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a job.

Declaration
public Task<UpdateJobResponse> UpdateJob(UpdateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateJobRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateJobResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateJob API.

UpdateJobRun(UpdateJobRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a job run.

Declaration
public Task<UpdateJobRunResponse> UpdateJobRun(UpdateJobRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateJobRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateJobRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateJobRun API.

UpdateModel(UpdateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a model. You can update the displayName, description, freeformTags, and definedTags properties.

Declaration
public Task<UpdateModelResponse> UpdateModel(UpdateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateModelRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateModelResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateModel API.

UpdateModelDeployment(UpdateModelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a model deployment. Some of the properties of modelDeploymentConfigurationDetails or CategoryLogDetails can also be updated with zero down time when the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e instanceShapeName, instanceCount and modelId, separately loadBalancerShape or CategoryLogDetails can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.

Declaration
public Task<UpdateModelDeploymentResponse> UpdateModelDeployment(UpdateModelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateModelDeploymentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateModelDeploymentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateModelDeployment API.

UpdateModelProvenance(UpdateModelProvenanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the provenance information for the specified model.

Declaration
public Task<UpdateModelProvenanceResponse> UpdateModelProvenance(UpdateModelProvenanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateModelProvenanceRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateModelProvenanceResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateModelProvenance API.

UpdateModelVersionSet(UpdateModelVersionSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a model version set. User can update the description property.

Declaration
public Task<UpdateModelVersionSetResponse> UpdateModelVersionSet(UpdateModelVersionSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateModelVersionSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateModelVersionSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateModelVersionSet API.

UpdateNotebookSession(UpdateNotebookSessionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a notebook session. You can update the displayName, freeformTags, and definedTags properties. When the notebook session is in the INACTIVE lifecycle state, you can update notebookSessionConfigurationDetails and change shape, subnetId, and blockStorageSizeInGBs. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

Declaration
public Task<UpdateNotebookSessionResponse> UpdateNotebookSession(UpdateNotebookSessionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateNotebookSessionRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateNotebookSessionResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateNotebookSession API.

UpdatePipeline(UpdatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Pipeline.

Declaration
public Task<UpdatePipelineResponse> UpdatePipeline(UpdatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdatePipelineRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdatePipelineResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdatePipeline API.

UpdatePipelineRun(UpdatePipelineRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the PipelineRun.

Declaration
public Task<UpdatePipelineRunResponse> UpdatePipelineRun(UpdatePipelineRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdatePipelineRunRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdatePipelineRunResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdatePipelineRun API.

UpdateProject(UpdateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a project. You can update the displayName, description, freeformTags, and definedTags properties.

Declaration
public Task<UpdateProjectResponse> UpdateProject(UpdateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateProjectRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateProjectResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateProject API.

Implements