Package com.seeq.api
Class JobsApi
java.lang.Object
com.seeq.api.JobsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateContentJob
(String body) Create a job to capture a content screenshot at a regular intervalcreateContentJobWithHeadersAndHttpInfo
(String body, Map<String, String> customHeaders) Create a job to capture a content screenshot at a regular intervalCreate a job to capture a content screenshot at a regular intervalcreateDateRangeJob
(String body) Create a job to update a date range and its content at a regular intervalcreateDateRangeJobWithHeadersAndHttpInfo
(String body, Map<String, String> customHeaders) Create a job to update a date range and its content at a regular intervalCreate a job to update a date range and its content at a regular intervalDelete a scheduled job and cancel any currently running instancedeleteJobWithHeadersAndHttpInfo
(String group, String id, String schedulerType, Map<String, String> customHeaders) Delete a scheduled job and cancel any currently running instancedeleteJobWithHttpInfo
(String group, String id, String schedulerType) Delete a scheduled job and cancel any currently running instanceGet details of a specified jobList of scheduled jobsgetJobsWithHeadersAndHttpInfo
(Integer offset, Integer limit, String schedulerType, Map<String, String> customHeaders) List of scheduled jobsgetJobsWithHttpInfo
(Integer offset, Integer limit, String schedulerType) List of scheduled jobsgetJobWithHeadersAndHttpInfo
(String group, String id, String schedulerType, Map<String, String> customHeaders) Get details of a specified jobgetJobWithHttpInfo
(String group, String id, String schedulerType) Get details of a specified joblong
A simplified endpoint for fetching a screenshot of Seeq content at a regular interval.getScreenshotFromContentWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) A simplified endpoint for fetching a screenshot of Seeq content at a regular interval.A simplified endpoint for fetching a screenshot of Seeq content at a regular interval.void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) Validate a list of Quartz cron expressionsvalidateCronWithHeadersAndHttpInfo
(ValidateCronListInputV1 body, Map<String, String> customHeaders) Validate a list of Quartz cron expressionsValidate a list of Quartz cron expressions
-
Constructor Details
-
JobsApi
public JobsApi() -
JobsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
createContentJob
Create a job to capture a content screenshot at a regular interval- Parameters:
body
- ID of the content (required)- Returns:
- JobOutputV1
- Throws:
ApiException
- if fails to make API call
-
createContentJobWithHttpInfo
public ApiClient.ApiResponse<JobOutputV1> createContentJobWithHttpInfo(String body) throws ApiException Create a job to capture a content screenshot at a regular interval- Parameters:
body
- ID of the content (required)- Throws:
ApiException
- if fails to make API call
-
createContentJobWithHeadersAndHttpInfo
public ApiClient.ApiResponse<JobOutputV1> createContentJobWithHeadersAndHttpInfo(String body, Map<String, String> customHeaders) throws ApiExceptionCreate a job to capture a content screenshot at a regular interval- Parameters:
body
- ID of the content (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createDateRangeJob
Create a job to update a date range and its content at a regular interval- Parameters:
body
- ID for the Date Range (required)- Returns:
- JobOutputV1
- Throws:
ApiException
- if fails to make API call
-
createDateRangeJobWithHttpInfo
public ApiClient.ApiResponse<JobOutputV1> createDateRangeJobWithHttpInfo(String body) throws ApiException Create a job to update a date range and its content at a regular interval- Parameters:
body
- ID for the Date Range (required)- Throws:
ApiException
- if fails to make API call
-
createDateRangeJobWithHeadersAndHttpInfo
public ApiClient.ApiResponse<JobOutputV1> createDateRangeJobWithHeadersAndHttpInfo(String body, Map<String, String> customHeaders) throws ApiExceptionCreate a job to update a date range and its content at a regular interval- Parameters:
body
- ID for the Date Range (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deleteJob
public StatusMessageBase deleteJob(String group, String id, String schedulerType) throws ApiException Delete a scheduled job and cancel any currently running instance- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to delete (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deleteJobWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteJobWithHttpInfo(String group, String id, String schedulerType) throws ApiException Delete a scheduled job and cancel any currently running instance- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to delete (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)- Throws:
ApiException
- if fails to make API call
-
deleteJobWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteJobWithHeadersAndHttpInfo(String group, String id, String schedulerType, Map<String, String> customHeaders) throws ApiExceptionDelete a scheduled job and cancel any currently running instance- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to delete (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getJob
Get details of a specified job- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to retrieve (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)- Returns:
- JobOutputV1
- Throws:
ApiException
- if fails to make API call
-
getJobWithHttpInfo
public ApiClient.ApiResponse<JobOutputV1> getJobWithHttpInfo(String group, String id, String schedulerType) throws ApiException Get details of a specified job- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to retrieve (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)- Throws:
ApiException
- if fails to make API call
-
getJobWithHeadersAndHttpInfo
public ApiClient.ApiResponse<JobOutputV1> getJobWithHeadersAndHttpInfo(String group, String id, String schedulerType, Map<String, String> customHeaders) throws ApiExceptionGet details of a specified job- Parameters:
group
- Group to which the job belongs (required)id
- ID of the job to retrieve (required)schedulerType
- Which scheduler to query for the job. The options are User (default), System, and AsyncMigration. (optional, default to User)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getJobs
public GetJobsOutputV1 getJobs(Integer offset, Integer limit, String schedulerType) throws ApiException List of scheduled jobs- Parameters:
offset
- The pagination offset, the index of the first job that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of jobs that will be returned in this page of results (optional, default to 40)schedulerType
- Which scheduler to query for jobs. The options are User (default), System, and AsyncMigration. (optional, default to User)- Returns:
- GetJobsOutputV1
- Throws:
ApiException
- if fails to make API call
-
getJobsWithHttpInfo
public ApiClient.ApiResponse<GetJobsOutputV1> getJobsWithHttpInfo(Integer offset, Integer limit, String schedulerType) throws ApiException List of scheduled jobs- Parameters:
offset
- The pagination offset, the index of the first job that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of jobs that will be returned in this page of results (optional, default to 40)schedulerType
- Which scheduler to query for jobs. The options are User (default), System, and AsyncMigration. (optional, default to User)- Throws:
ApiException
- if fails to make API call
-
getJobsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetJobsOutputV1> getJobsWithHeadersAndHttpInfo(Integer offset, Integer limit, String schedulerType, Map<String, String> customHeaders) throws ApiExceptionList of scheduled jobs- Parameters:
offset
- The pagination offset, the index of the first job that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of jobs that will be returned in this page of results (optional, default to 40)schedulerType
- Which scheduler to query for jobs. The options are User (default), System, and AsyncMigration. (optional, default to User)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getScreenshotFromContent
A simplified endpoint for fetching a screenshot of Seeq content at a regular interval.- Parameters:
id
- The content id to capture (required)- Returns:
- ScreenshotOutputV1
- Throws:
ApiException
- if fails to make API call
-
getScreenshotFromContentWithHttpInfo
public ApiClient.ApiResponse<ScreenshotOutputV1> getScreenshotFromContentWithHttpInfo(String id) throws ApiException A simplified endpoint for fetching a screenshot of Seeq content at a regular interval.- Parameters:
id
- The content id to capture (required)- Throws:
ApiException
- if fails to make API call
-
getScreenshotFromContentWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ScreenshotOutputV1> getScreenshotFromContentWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionA simplified endpoint for fetching a screenshot of Seeq content at a regular interval.- Parameters:
id
- The content id to capture (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
validateCron
Validate a list of Quartz cron expressions- Parameters:
body
- The list of cron schedules to evaluate (required)- Returns:
- ValidateCronListOutputV1
- Throws:
ApiException
- if fails to make API call
-
validateCronWithHttpInfo
public ApiClient.ApiResponse<ValidateCronListOutputV1> validateCronWithHttpInfo(ValidateCronListInputV1 body) throws ApiException Validate a list of Quartz cron expressions- Parameters:
body
- The list of cron schedules to evaluate (required)- Throws:
ApiException
- if fails to make API call
-
validateCronWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ValidateCronListOutputV1> validateCronWithHeadersAndHttpInfo(ValidateCronListInputV1 body, Map<String, String> customHeaders) throws ApiExceptionValidate a list of Quartz cron expressions- Parameters:
body
- The list of cron schedules to evaluate (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-