Package com.seeq.api
Class ProjectsApi
java.lang.Object
com.seeq.api.ProjectsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionarchiveProject
(String id) Archive a projectarchiveProjectWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a projectArchive a projectcreateProject
(ProjectInputV1 body) Create a projectcreateProjectWithHeadersAndHttpInfo
(ProjectInputV1 body, Map<String, String> customHeaders) Create a projectCreate a projectgetProject
(String id) Get a projectgetProjects
(Integer offset, Integer limit) List projectsList projectsgetProjectsWithHttpInfo
(Integer offset, Integer limit) List projectsgetProjectWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a projectGet a projectlong
putProject
(String id, ProjectInputV1 body) Update a projectputProjectWithHeadersAndHttpInfo
(String id, ProjectInputV1 body, Map<String, String> customHeaders) Update a projectputProjectWithHttpInfo
(String id, ProjectInputV1 body) Update a projectscheduleNotebook
(String id, ScheduledNotebookInputV1 body) Schedule a Notebook within a Project to run on a set intervalscheduleNotebookWithHeadersAndHttpInfo
(String id, ScheduledNotebookInputV1 body, Map<String, String> customHeaders) Schedule a Notebook within a Project to run on a set intervalSchedule a Notebook within a Project to run on a set intervalvoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) unscheduleNotebook
(String id, String filePath, String label) Archive Scheduled Notebook(s) within a Project so that it will no longer rununscheduleNotebookWithHeadersAndHttpInfo
(String id, String filePath, String label, Map<String, String> customHeaders) Archive Scheduled Notebook(s) within a Project so that it will no longer rununscheduleNotebookWithHttpInfo
(String id, String filePath, String label) Archive Scheduled Notebook(s) within a Project so that it will no longer run
-
Constructor Details
-
ProjectsApi
public ProjectsApi() -
ProjectsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveProject
Archive a project- Parameters:
id
- ID of the project to archive (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveProjectWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveProjectWithHttpInfo(String id) throws ApiException Archive a project- Parameters:
id
- ID of the project to archive (required)- Throws:
ApiException
- if fails to make API call
-
archiveProjectWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveProjectWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a project- Parameters:
id
- ID of the project to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createProject
Create a project- Parameters:
body
- Project information (required)- Returns:
- ProjectOutputV1
- Throws:
ApiException
- if fails to make API call
-
createProjectWithHttpInfo
public ApiClient.ApiResponse<ProjectOutputV1> createProjectWithHttpInfo(ProjectInputV1 body) throws ApiException Create a project- Parameters:
body
- Project information (required)- Throws:
ApiException
- if fails to make API call
-
createProjectWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ProjectOutputV1> createProjectWithHeadersAndHttpInfo(ProjectInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a project- Parameters:
body
- Project information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getProject
Get a project- Parameters:
id
- ID of the project to retrieve (required)- Returns:
- ProjectOutputV1
- Throws:
ApiException
- if fails to make API call
-
getProjectWithHttpInfo
Get a project- Parameters:
id
- ID of the project to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getProjectWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ProjectOutputV1> getProjectWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a project- Parameters:
id
- ID of the project to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getProjects
List projects- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- GetProjectsOutputV1
- Throws:
ApiException
- if fails to make API call
-
getProjectsWithHttpInfo
public ApiClient.ApiResponse<GetProjectsOutputV1> getProjectsWithHttpInfo(Integer offset, Integer limit) throws ApiException List projects- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getProjectsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetProjectsOutputV1> getProjectsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionList projects- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putProject
Update a project- Parameters:
id
- The Seeq ID for the project (required)body
- (required)- Returns:
- ProjectOutputV1
- Throws:
ApiException
- if fails to make API call
-
putProjectWithHttpInfo
public ApiClient.ApiResponse<ProjectOutputV1> putProjectWithHttpInfo(String id, ProjectInputV1 body) throws ApiException Update a project- Parameters:
id
- The Seeq ID for the project (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
putProjectWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ProjectOutputV1> putProjectWithHeadersAndHttpInfo(String id, ProjectInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate a project- Parameters:
id
- The Seeq ID for the project (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
scheduleNotebook
public ScheduledNotebookOutputV1 scheduleNotebook(String id, ScheduledNotebookInputV1 body) throws ApiException Schedule a Notebook within a Project to run on a set interval- Parameters:
id
- ID of the Project containing the Notebook to schedule (required)body
- The Notebook schedule information (required)- Returns:
- ScheduledNotebookOutputV1
- Throws:
ApiException
- if fails to make API call
-
scheduleNotebookWithHttpInfo
public ApiClient.ApiResponse<ScheduledNotebookOutputV1> scheduleNotebookWithHttpInfo(String id, ScheduledNotebookInputV1 body) throws ApiException Schedule a Notebook within a Project to run on a set interval- Parameters:
id
- ID of the Project containing the Notebook to schedule (required)body
- The Notebook schedule information (required)- Throws:
ApiException
- if fails to make API call
-
scheduleNotebookWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ScheduledNotebookOutputV1> scheduleNotebookWithHeadersAndHttpInfo(String id, ScheduledNotebookInputV1 body, Map<String, String> customHeaders) throws ApiExceptionSchedule a Notebook within a Project to run on a set interval- Parameters:
id
- ID of the Project containing the Notebook to schedule (required)body
- The Notebook schedule information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
unscheduleNotebook
public ScheduledNotebookListOutputV1 unscheduleNotebook(String id, String filePath, String label) throws ApiException Archive Scheduled Notebook(s) within a Project so that it will no longer run- Parameters:
id
- ID of the Project containing the Notebook to unschedule (required)filePath
- The path to the Notebook file. Using '*' will unschedule all Notebooks for this Project, regardless of their label (required)label
- The label for the Notebook schedule. Using '*' will unschedule all labels for this filePath (optional)- Returns:
- ScheduledNotebookListOutputV1
- Throws:
ApiException
- if fails to make API call
-
unscheduleNotebookWithHttpInfo
public ApiClient.ApiResponse<ScheduledNotebookListOutputV1> unscheduleNotebookWithHttpInfo(String id, String filePath, String label) throws ApiException Archive Scheduled Notebook(s) within a Project so that it will no longer run- Parameters:
id
- ID of the Project containing the Notebook to unschedule (required)filePath
- The path to the Notebook file. Using '*' will unschedule all Notebooks for this Project, regardless of their label (required)label
- The label for the Notebook schedule. Using '*' will unschedule all labels for this filePath (optional)- Throws:
ApiException
- if fails to make API call
-
unscheduleNotebookWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ScheduledNotebookListOutputV1> unscheduleNotebookWithHeadersAndHttpInfo(String id, String filePath, String label, Map<String, String> customHeaders) throws ApiExceptionArchive Scheduled Notebook(s) within a Project so that it will no longer run- Parameters:
id
- ID of the Project containing the Notebook to unschedule (required)filePath
- The path to the Notebook file. Using '*' will unschedule all Notebooks for this Project, regardless of their label (required)label
- The label for the Notebook schedule. Using '*' will unschedule all labels for this filePath (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-