@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.
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.ActivateModelResponse activateModel(ActivateModelRequest request)
Activates the model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ActivateModel API.
ActivateNotebookSessionResponse activateNotebookSession(ActivateNotebookSessionRequest request)
Activates the notebook session.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ActivateNotebookSession API.
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Cancels a work request that has not started.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CancelWorkRequest API.
ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)
Moves a model resource into a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeModelCompartment API.
ChangeNotebookSessionCompartmentResponse changeNotebookSessionCompartment(ChangeNotebookSessionCompartmentRequest request)
Moves a notebook session resource into a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeNotebookSessionCompartment API.
ChangeProjectCompartmentResponse changeProjectCompartment(ChangeProjectCompartmentRequest request)
Moves a project resource into a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeProjectCompartment API.
CreateModelResponse createModel(CreateModelRequest request)
Creates a new model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateModel API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateModelArtifact API.
CreateModelProvenanceResponse createModelProvenance(CreateModelProvenanceRequest request)
Creates provenance information for the specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateModelProvenance API.
CreateNotebookSessionResponse createNotebookSession(CreateNotebookSessionRequest request)
Creates a new notebook session.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateNotebookSession API.
CreateProjectResponse createProject(CreateProjectRequest request)
Creates a new project.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateProject API.
DeactivateModelResponse deactivateModel(DeactivateModelRequest request)
Deactivates the model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeactivateModel API.
DeactivateNotebookSessionResponse deactivateNotebookSession(DeactivateNotebookSessionRequest request)
Deactivates the notebook session.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeactivateNotebookSession API.
DeleteModelResponse deleteModel(DeleteModelRequest request)
Deletes the specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteModel API.
DeleteNotebookSessionResponse deleteNotebookSession(DeleteNotebookSessionRequest request)
Deletes the specified notebook session. Any unsaved work in this notebook session will be lost.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteNotebookSession API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteProject API.
GetModelResponse getModel(GetModelRequest request)
Gets the specified model’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetModel API.
GetModelArtifactContentResponse getModelArtifactContent(GetModelArtifactContentRequest request)
Downloads model artifact content for specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetModelArtifactContent API.
GetModelProvenanceResponse getModelProvenance(GetModelProvenanceRequest request)
Gets provenance information for specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetModelProvenance API.
GetNotebookSessionResponse getNotebookSession(GetNotebookSessionRequest request)
Gets the specified notebook session’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetNotebookSession API.
GetProjectResponse getProject(GetProjectRequest request)
Gets the specified project’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetProject API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the specified work request’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetWorkRequest API.
HeadModelArtifactResponse headModelArtifact(HeadModelArtifactRequest request)
Gets model artifact metadata for specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use HeadModelArtifact API.
ListModelsResponse listModels(ListModelsRequest request)
Lists models in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListModels API.
ListNotebookSessionShapesResponse listNotebookSessionShapes(ListNotebookSessionShapesRequest request)
Lists the valid notebook session shapes.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListNotebookSessionShapes API.
ListNotebookSessionsResponse listNotebookSessions(ListNotebookSessionsRequest request)
Lists notebook sessions in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListNotebookSessions API.
ListProjectsResponse listProjects(ListProjectsRequest request)
Lists projects in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListProjects API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists work request errors for the specified work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Lists work request logs for the specified work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists work requests in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequests API.
UpdateModelResponse updateModel(UpdateModelRequest request)
Updates the properties of a model. You can update the displayName
, description
, freeformTags
, and definedTags
properties.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateModel API.
UpdateModelProvenanceResponse updateModelProvenance(UpdateModelProvenanceRequest request)
Updates provenance information for the specified model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateModelProvenance API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateNotebookSession API.
UpdateProjectResponse updateProject(UpdateProjectRequest request)
Updates the properties of a project. You can update the displayName
, description
, freeformTags
, and definedTags
properties.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateProject API.
DataScienceWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2021. All rights reserved.