com.oracle.bmc.datascience

Interface DataScience

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DataScienceClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190101")
public interface DataScience
extends AutoCloseable

Use the Data Science APIs to organize your data science work, access data and computing resources, and build, train, deploy, and manage models on Oracle Cloud.

Method Summary

Modifier and Type	Method and Description
ActivateModelResponse	activateModel(ActivateModelRequest request) Activates the model.
ActivateNotebookSessionResponse	activateNotebookSession(ActivateNotebookSessionRequest request) Activates the notebook session.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request) Cancels a work request that has not started.
ChangeModelCompartmentResponse	changeModelCompartment(ChangeModelCompartmentRequest request) Moves a model resource into a different compartment.
ChangeNotebookSessionCompartmentResponse	changeNotebookSessionCompartment(ChangeNotebookSessionCompartmentRequest request) Moves a notebook session resource into a different compartment.
ChangeProjectCompartmentResponse	changeProjectCompartment(ChangeProjectCompartmentRequest request) Moves a project resource into a different compartment.
CreateModelResponse	createModel(CreateModelRequest request) Creates a new model.
CreateModelArtifactResponse	createModelArtifact(CreateModelArtifactRequest request) Creates model artifact for specified model.
CreateModelProvenanceResponse	createModelProvenance(CreateModelProvenanceRequest request) Creates provenance information for the specified model.
CreateNotebookSessionResponse	createNotebookSession(CreateNotebookSessionRequest request) Creates a new notebook session.
CreateProjectResponse	createProject(CreateProjectRequest request) Creates a new project.
DeactivateModelResponse	deactivateModel(DeactivateModelRequest request) Deactivates the model.
DeactivateNotebookSessionResponse	deactivateNotebookSession(DeactivateNotebookSessionRequest request) Deactivates the notebook session.
DeleteModelResponse	deleteModel(DeleteModelRequest request) Deletes the specified model.
DeleteNotebookSessionResponse	deleteNotebookSession(DeleteNotebookSessionRequest request) Deletes the specified notebook session.
DeleteProjectResponse	deleteProject(DeleteProjectRequest request) Deletes the specified project.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetModelResponse	getModel(GetModelRequest request) Gets the specified model’s information.
GetModelArtifactContentResponse	getModelArtifactContent(GetModelArtifactContentRequest request) Downloads model artifact content for specified model.
GetModelProvenanceResponse	getModelProvenance(GetModelProvenanceRequest request) Gets provenance information for specified model.
GetNotebookSessionResponse	getNotebookSession(GetNotebookSessionRequest request) Gets the specified notebook session’s information.
DataSciencePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetProjectResponse	getProject(GetProjectRequest request) Gets the specified project’s information.
DataScienceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the specified work request’s information.
HeadModelArtifactResponse	headModelArtifact(HeadModelArtifactRequest request) Gets model artifact metadata for specified model.
ListModelsResponse	listModels(ListModelsRequest request) Lists models in the specified compartment.
ListNotebookSessionsResponse	listNotebookSessions(ListNotebookSessionsRequest request) Lists notebook sessions in the specified compartment.
ListNotebookSessionShapesResponse	listNotebookSessionShapes(ListNotebookSessionShapesRequest request) Lists the valid notebook session shapes.
ListProjectsResponse	listProjects(ListProjectsRequest request) Lists projects in the specified compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Lists work request errors for the specified work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Lists work request logs for the specified work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists work requests in the specified compartment.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateModelResponse	updateModel(UpdateModelRequest request) Updates the properties of a model.
UpdateModelProvenanceResponse	updateModelProvenance(UpdateModelProvenanceRequest request) Updates provenance information for the specified model.
UpdateNotebookSessionResponse	updateNotebookSession(UpdateNotebookSessionRequest request) Updates the properties of a notebook session.
UpdateProjectResponse	updateProject(UpdateProjectRequest request) Updates the properties of a project.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

activateModel

ActivateModelResponse activateModel(ActivateModelRequest request)

Activates the model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ActivateModel API.

activateNotebookSession

ActivateNotebookSessionResponse activateNotebookSession(ActivateNotebookSessionRequest request)

Activates the notebook session.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ActivateNotebookSession API.

cancelWorkRequest

CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Cancels a work request that has not started.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CancelWorkRequest API.

changeModelCompartment

ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)

Moves a model resource into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeModelCompartment API.

changeNotebookSessionCompartment

ChangeNotebookSessionCompartmentResponse changeNotebookSessionCompartment(ChangeNotebookSessionCompartmentRequest request)

Moves a notebook session resource into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeNotebookSessionCompartment API.

changeProjectCompartment

ChangeProjectCompartmentResponse changeProjectCompartment(ChangeProjectCompartmentRequest request)

Moves a project resource into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeProjectCompartment API.

createModel

CreateModelResponse createModel(CreateModelRequest request)

Creates a new model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateModel API.

createModelArtifact

CreateModelArtifactResponse createModelArtifact(CreateModelArtifactRequest request)

Creates model artifact for specified model.

Note: This operation consumes a stream.

If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this operation is called}.

Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation was called.

If the stream is a FileInputStream, and the stream’s FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream’s FileChannel position cannot be changed (like for a named pipe), then the stream’s contents will be buffered in memory, as described below.

If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.

The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateModelArtifact API.

createModelProvenance

CreateModelProvenanceResponse createModelProvenance(CreateModelProvenanceRequest request)

Creates provenance information for the specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateModelProvenance API.

createNotebookSession

CreateNotebookSessionResponse createNotebookSession(CreateNotebookSessionRequest request)

Creates a new notebook session.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateNotebookSession API.

createProject

CreateProjectResponse createProject(CreateProjectRequest request)

Creates a new project.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateProject API.

deactivateModel

DeactivateModelResponse deactivateModel(DeactivateModelRequest request)

Deactivates the model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeactivateModel API.

deactivateNotebookSession

DeactivateNotebookSessionResponse deactivateNotebookSession(DeactivateNotebookSessionRequest request)

Deactivates the notebook session.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeactivateNotebookSession API.

deleteModel

DeleteModelResponse deleteModel(DeleteModelRequest request)

Deletes the specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteModel API.

deleteNotebookSession

DeleteNotebookSessionResponse deleteNotebookSession(DeleteNotebookSessionRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteNotebookSession API.

deleteProject

DeleteProjectResponse deleteProject(DeleteProjectRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteProject API.

getModel

GetModelResponse getModel(GetModelRequest request)

Gets the specified model’s information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetModel API.

getModelArtifactContent

GetModelArtifactContentResponse getModelArtifactContent(GetModelArtifactContentRequest request)

Downloads model artifact content for specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetModelArtifactContent API.

getModelProvenance

GetModelProvenanceResponse getModelProvenance(GetModelProvenanceRequest request)

Gets provenance information for specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetModelProvenance API.

getNotebookSession

GetNotebookSessionResponse getNotebookSession(GetNotebookSessionRequest request)

Gets the specified notebook session’s information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetNotebookSession API.

getProject

GetProjectResponse getProject(GetProjectRequest request)

Gets the specified project’s information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetProject API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Gets the specified work request’s information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetWorkRequest API.

headModelArtifact

HeadModelArtifactResponse headModelArtifact(HeadModelArtifactRequest request)

Gets model artifact metadata for specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use HeadModelArtifact API.

listModels

ListModelsResponse listModels(ListModelsRequest request)

Lists models in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListModels API.

listNotebookSessionShapes

ListNotebookSessionShapesResponse listNotebookSessionShapes(ListNotebookSessionShapesRequest request)

Lists the valid notebook session shapes.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListNotebookSessionShapes API.

listNotebookSessions

ListNotebookSessionsResponse listNotebookSessions(ListNotebookSessionsRequest request)

Lists notebook sessions in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListNotebookSessions API.

listProjects

ListProjectsResponse listProjects(ListProjectsRequest request)

Lists projects in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListProjects API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Lists work request errors for the specified work request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Lists work request logs for the specified work request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Lists work requests in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequests API.

updateModel

UpdateModelResponse updateModel(UpdateModelRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateModel API.

updateModelProvenance

UpdateModelProvenanceResponse updateModelProvenance(UpdateModelProvenanceRequest request)

Updates provenance information for the specified model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateModelProvenance API.

updateNotebookSession

UpdateNotebookSessionResponse updateNotebookSession(UpdateNotebookSessionRequest request)

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 will take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateNotebookSession API.

updateProject

UpdateProjectResponse updateProject(UpdateProjectRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateProject API.

getWaiters

DataScienceWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

DataSciencePaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.