Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataScienceClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DataScienceClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DataScienceClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DataScienceClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "DataScience"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://datascience.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

activateModel

  • Activates the model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ActivateModel API.

    Parameters

    Returns Promise<ActivateModelResponse>

    ActivateModelResponse

activateModelDeployment

activateNotebookSession

cancelJobRun

  • Cancels an IN_PROGRESS job run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelJobRun API.

    Parameters

    Returns Promise<CancelJobRunResponse>

    CancelJobRunResponse

cancelPipelineRun

cancelWorkRequest

changeDataSciencePrivateEndpointCompartment

changeJobCompartment

changeJobRunCompartment

changeModelCompartment

changeModelDeploymentCompartment

changeModelVersionSetCompartment

changeNotebookSessionCompartment

changePipelineCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangePipelineCompartment API.

    Parameters

    Returns Promise<ChangePipelineCompartmentResponse>

    ChangePipelineCompartmentResponse

changePipelineRunCompartment

changeProjectCompartment

close

  • close(): void

createDataSciencePrivateEndpoint

createJob

  • Creates a job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateJob API.

    Parameters

    Returns Promise<CreateJobResponse>

    CreateJobResponse

createJobArtifact

createJobRun

  • Creates a job run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateJobRun API.

    Parameters

    Returns Promise<CreateJobRunResponse>

    CreateJobRunResponse

createModel

  • Creates a new model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateModel API.

    Parameters

    Returns Promise<CreateModelResponse>

    CreateModelResponse

createModelArtifact

createModelDeployment

createModelProvenance

createModelVersionSet

createNotebookSession

createPipeline

createPipelineRun

createProject

  • Creates a new project. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateProject API.

    Parameters

    Returns Promise<CreateProjectResponse>

    CreateProjectResponse

createStepArtifact

createWaiters

  • Creates a new DataScienceWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DataScienceWaiter

    The service waiters.

deactivateModel

deactivateModelDeployment

deactivateNotebookSession

deleteDataSciencePrivateEndpoint

deleteJob

  • Deletes a job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteJob API.

    Parameters

    Returns Promise<DeleteJobResponse>

    DeleteJobResponse

deleteJobRun

  • Deletes a job run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteJobRun API.

    Parameters

    Returns Promise<DeleteJobRunResponse>

    DeleteJobRunResponse

deleteModel

  • Deletes the specified model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteModel API.

    Parameters

    Returns Promise<DeleteModelResponse>

    DeleteModelResponse

deleteModelDeployment

  • Deletes the specified model deployment. Any unsaved work in this model deployment is lost. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteModelDeployment API.

    Parameters

    Returns Promise<DeleteModelDeploymentResponse>

    DeleteModelDeploymentResponse

deleteModelVersionSet

deleteNotebookSession

  • Deletes the specified notebook session. Any unsaved work in this notebook session are lost. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteNotebookSession API.

    Parameters

    Returns Promise<DeleteNotebookSessionResponse>

    DeleteNotebookSessionResponse

deletePipeline

deletePipelineRun

deleteProject

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteProject API.

    Parameters

    Returns Promise<DeleteProjectResponse>

    DeleteProjectResponse

exportModelArtifact

  • Export model artifact from source to the service bucket This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportModelArtifact API.

    Parameters

    Returns Promise<ExportModelArtifactResponse>

    ExportModelArtifactResponse

getDataSciencePrivateEndpoint

getJob

  • Gets a job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJob API.

    Parameters

    Returns Promise<GetJobResponse>

    GetJobResponse

getJobArtifactContent

getJobRun

  • Gets a job run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJobRun API.

    Parameters

    Returns Promise<GetJobRunResponse>

    GetJobRunResponse

getModel

  • Gets the specified model's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetModel API.

    Parameters

    Returns Promise<GetModelResponse>

    GetModelResponse

getModelArtifactContent

getModelDeployment

  • Retrieves the model deployment for the specified modelDeploymentId. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetModelDeployment API.

    Parameters

    Returns Promise<GetModelDeploymentResponse>

    GetModelDeploymentResponse

getModelProvenance

  • Gets provenance information for specified model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetModelProvenance API.

    Parameters

    Returns Promise<GetModelProvenanceResponse>

    GetModelProvenanceResponse

getModelVersionSet

  • Gets the specified model version set information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetModelVersionSet API.

    Parameters

    Returns Promise<GetModelVersionSetResponse>

    GetModelVersionSetResponse

getNotebookSession

  • Gets the specified notebook session's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNotebookSession API.

    Parameters

    Returns Promise<GetNotebookSessionResponse>

    GetNotebookSessionResponse

getPipeline

  • Gets a Pipeline by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPipeline API.

    Parameters

    Returns Promise<GetPipelineResponse>

    GetPipelineResponse

getPipelineRun

  • Gets a PipelineRun by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPipelineRun API.

    Parameters

    Returns Promise<GetPipelineRunResponse>

    GetPipelineRunResponse

getProject

  • Gets the specified project's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProject API.

    Parameters

    Returns Promise<GetProjectResponse>

    GetProjectResponse

getStepArtifactContent

getWaiters

getWorkRequest

  • Gets the specified work request's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

headJobArtifact

headModelArtifact

  • Gets model artifact metadata for specified model. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use HeadModelArtifact API.

    Parameters

    Returns Promise<HeadModelArtifactResponse>

    HeadModelArtifactResponse

headStepArtifact

  • Get the artifact metadata for a step in the pipeline. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use HeadStepArtifact API.

    Parameters

    Returns Promise<HeadStepArtifactResponse>

    HeadStepArtifactResponse

importModelArtifact

listAllDataSciencePrivateEndpoints

  • NOTE: This function is deprecated in favor of listDataSciencePrivateEndpointsRecordIterator function. Creates a new async iterator which will iterate over the models.DataSciencePrivateEndpointSummary objects contained in responses from the listDataSciencePrivateEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DataSciencePrivateEndpointSummary>

listAllDataSciencePrivateEndpointsResponses

listAllFastLaunchJobConfigs

  • NOTE: This function is deprecated in favor of listFastLaunchJobConfigsRecordIterator function. Creates a new async iterator which will iterate over the models.FastLaunchJobConfigSummary objects contained in responses from the listFastLaunchJobConfigs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<FastLaunchJobConfigSummary>

listAllFastLaunchJobConfigsResponses

  • NOTE: This function is deprecated in favor of listFastLaunchJobConfigsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listFastLaunchJobConfigs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListFastLaunchJobConfigsResponse>

listAllJobRuns

  • NOTE: This function is deprecated in favor of listJobRunsRecordIterator function. Creates a new async iterator which will iterate over the models.JobRunSummary objects contained in responses from the listJobRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<JobRunSummary>

listAllJobRunsResponses

  • NOTE: This function is deprecated in favor of listJobRunsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listJobRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListJobRunsResponse>

listAllJobShapes

  • NOTE: This function is deprecated in favor of listJobShapesRecordIterator function. Creates a new async iterator which will iterate over the models.JobShapeSummary objects contained in responses from the listJobShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<JobShapeSummary>

listAllJobShapesResponses

  • NOTE: This function is deprecated in favor of listJobShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listJobShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListJobShapesResponse>

listAllJobs

  • NOTE: This function is deprecated in favor of listJobsRecordIterator function. Creates a new async iterator which will iterate over the models.JobSummary objects contained in responses from the listJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<JobSummary>

listAllJobsResponses

  • NOTE: This function is deprecated in favor of listJobsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListJobsResponse>

listAllModelDeploymentShapes

  • NOTE: This function is deprecated in favor of listModelDeploymentShapesRecordIterator function. Creates a new async iterator which will iterate over the models.ModelDeploymentShapeSummary objects contained in responses from the listModelDeploymentShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModelDeploymentShapeSummary>

listAllModelDeploymentShapesResponses

listAllModelDeployments

  • NOTE: This function is deprecated in favor of listModelDeploymentsRecordIterator function. Creates a new async iterator which will iterate over the models.ModelDeploymentSummary objects contained in responses from the listModelDeployments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModelDeploymentSummary>

listAllModelDeploymentsResponses

  • NOTE: This function is deprecated in favor of listModelDeploymentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listModelDeployments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListModelDeploymentsResponse>

listAllModelVersionSets

  • NOTE: This function is deprecated in favor of listModelVersionSetsRecordIterator function. Creates a new async iterator which will iterate over the models.ModelVersionSetSummary objects contained in responses from the listModelVersionSets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModelVersionSetSummary>

listAllModelVersionSetsResponses

  • NOTE: This function is deprecated in favor of listModelVersionSetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listModelVersionSets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListModelVersionSetsResponse>

listAllModels

  • NOTE: This function is deprecated in favor of listModelsRecordIterator function. Creates a new async iterator which will iterate over the models.ModelSummary objects contained in responses from the listModels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModelSummary>

listAllModelsResponses

  • NOTE: This function is deprecated in favor of listModelsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listModels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListModelsResponse>

listAllNotebookSessionShapes

  • NOTE: This function is deprecated in favor of listNotebookSessionShapesRecordIterator function. Creates a new async iterator which will iterate over the models.NotebookSessionShapeSummary objects contained in responses from the listNotebookSessionShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NotebookSessionShapeSummary>

listAllNotebookSessionShapesResponses

listAllNotebookSessions

  • NOTE: This function is deprecated in favor of listNotebookSessionsRecordIterator function. Creates a new async iterator which will iterate over the models.NotebookSessionSummary objects contained in responses from the listNotebookSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NotebookSessionSummary>

listAllNotebookSessionsResponses

  • NOTE: This function is deprecated in favor of listNotebookSessionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listNotebookSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListNotebookSessionsResponse>

listAllPipelineRuns

  • NOTE: This function is deprecated in favor of listPipelineRunsRecordIterator function. Creates a new async iterator which will iterate over the models.PipelineRunSummary objects contained in responses from the listPipelineRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PipelineRunSummary>

listAllPipelineRunsResponses

  • NOTE: This function is deprecated in favor of listPipelineRunsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPipelineRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPipelineRunsResponse>

listAllPipelines

  • NOTE: This function is deprecated in favor of listPipelinesRecordIterator function. Creates a new async iterator which will iterate over the models.PipelineSummary objects contained in responses from the listPipelines operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PipelineSummary>

listAllPipelinesResponses

  • NOTE: This function is deprecated in favor of listPipelinesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPipelines operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPipelinesResponse>

listAllProjects

  • NOTE: This function is deprecated in favor of listProjectsRecordIterator function. Creates a new async iterator which will iterate over the models.ProjectSummary objects contained in responses from the listProjects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProjectSummary>

listAllProjectsResponses

  • NOTE: This function is deprecated in favor of listProjectsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listProjects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListProjectsResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listDataSciencePrivateEndpoints

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDataSciencePrivateEndpoints API.

    Parameters

    Returns Promise<ListDataSciencePrivateEndpointsResponse>

    ListDataSciencePrivateEndpointsResponse

listDataSciencePrivateEndpointsRecordIterator

listDataSciencePrivateEndpointsResponseIterator

listFastLaunchJobConfigs

listFastLaunchJobConfigsRecordIterator

listFastLaunchJobConfigsResponseIterator

listJobRuns

  • List out job runs. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobRuns API.

    Parameters

    Returns Promise<ListJobRunsResponse>

    ListJobRunsResponse

listJobRunsRecordIterator

  • Creates a new async iterator which will iterate over the models.JobRunSummary objects contained in responses from the listJobRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<JobRunSummary>

listJobRunsResponseIterator

listJobShapes

  • List job shapes available in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobShapes API.

    Parameters

    Returns Promise<ListJobShapesResponse>

    ListJobShapesResponse

listJobShapesRecordIterator

  • Creates a new async iterator which will iterate over the models.JobShapeSummary objects contained in responses from the listJobShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<JobShapeSummary>

listJobShapesResponseIterator

listJobs

  • List jobs in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobs API.

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listJobsRecordIterator

  • Creates a new async iterator which will iterate over the models.JobSummary objects contained in responses from the listJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<JobSummary>

listJobsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListJobsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListJobsResponse>

listModelDeploymentShapes

listModelDeploymentShapesRecordIterator

listModelDeploymentShapesResponseIterator

listModelDeployments

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModelDeployments API.

    Parameters

    Returns Promise<ListModelDeploymentsResponse>

    ListModelDeploymentsResponse

listModelDeploymentsRecordIterator

listModelDeploymentsResponseIterator

listModelVersionSets

listModelVersionSetsRecordIterator

listModelVersionSetsResponseIterator

listModels

  • Lists models in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModels API.

    Parameters

    Returns Promise<ListModelsResponse>

    ListModelsResponse

listModelsRecordIterator

  • Creates a new async iterator which will iterate over the models.ModelSummary objects contained in responses from the listModels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModelSummary>

listModelsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listModels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListModelsResponse>

listNotebookSessionShapes

listNotebookSessionShapesRecordIterator

listNotebookSessionShapesResponseIterator

listNotebookSessions

  • Lists the notebook sessions in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListNotebookSessions API.

    Parameters

    Returns Promise<ListNotebookSessionsResponse>

    ListNotebookSessionsResponse

listNotebookSessionsRecordIterator

listNotebookSessionsResponseIterator

listPipelineRuns

listPipelineRunsRecordIterator

  • Creates a new async iterator which will iterate over the models.PipelineRunSummary objects contained in responses from the listPipelineRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PipelineRunSummary>

listPipelineRunsResponseIterator

listPipelines

  • Returns a list of Pipelines. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPipelines API.

    Parameters

    Returns Promise<ListPipelinesResponse>

    ListPipelinesResponse

listPipelinesRecordIterator

  • Creates a new async iterator which will iterate over the models.PipelineSummary objects contained in responses from the listPipelines operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PipelineSummary>

listPipelinesResponseIterator

listProjects

  • Lists projects in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProjects API.

    Parameters

    Returns Promise<ListProjectsResponse>

    ListProjectsResponse

listProjectsRecordIterator

  • Creates a new async iterator which will iterate over the models.ProjectSummary objects contained in responses from the listProjects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProjectSummary>

listProjectsResponseIterator

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

  • Lists work request logs for the specified work request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

  • Lists work requests in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateDataSciencePrivateEndpoint

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDataSciencePrivateEndpoint API.

    Parameters

    Returns Promise<UpdateDataSciencePrivateEndpointResponse>

    UpdateDataSciencePrivateEndpointResponse

updateJob

  • Updates a job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateJob API.

    Parameters

    Returns Promise<UpdateJobResponse>

    UpdateJobResponse

updateJobRun

  • Updates a job run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateJobRun API.

    Parameters

    Returns Promise<UpdateJobRunResponse>

    UpdateJobRunResponse

updateModel

  • Updates the properties of a model. You can update the displayName, description, freeformTags, and definedTags properties. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateModel API.

    Parameters

    Returns Promise<UpdateModelResponse>

    UpdateModelResponse

updateModelDeployment

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateModelDeployment API.

    Parameters

    Returns Promise<UpdateModelDeploymentResponse>

    UpdateModelDeploymentResponse

updateModelProvenance

updateModelVersionSet

  • Updates the properties of a model version set. User can update the description property. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateModelVersionSet API.

    Parameters

    Returns Promise<UpdateModelVersionSetResponse>

    UpdateModelVersionSetResponse

updateNotebookSession

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateNotebookSession API.

    Parameters

    Returns Promise<UpdateNotebookSessionResponse>

    UpdateNotebookSessionResponse

updatePipeline

updatePipelineRun

updateProject

  • Updates the properties of a project. You can update the displayName, description, freeformTags, and definedTags properties. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateProject API.

    Parameters

    Returns Promise<UpdateProjectResponse>

    UpdateProjectResponse