PollinationSDK.Api.JobsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
CancelJob	PUT /projects/{owner}/{name}/jobs/{job_id}/cancel	Cancel a Job
CreateJob	POST /projects/{owner}/{name}/jobs	Schedule a job
DeleteJob	DELETE /projects/{owner}/{name}/jobs/{job_id}	Delete a Job
DownloadJobArtifact	GET /projects/{owner}/{name}/jobs/{job_id}/artifacts/download	Download an artifact from the job folder
GetJob	GET /projects/{owner}/{name}/jobs/{job_id}	Get a Job
ListJobs	GET /projects/{owner}/{name}/jobs	List Jobs
RetryJob	PUT /projects/{owner}/{name}/jobs/{job_id}/retry	Retry failed runs for a Job
SearchJobFolder	GET /projects/{owner}/{name}/jobs/{job_id}/artifacts	List files/folders in a job folder

CancelJob

CloudJob CancelJob (string owner, string name, string jobId)

Cancel a Job

Retrieve a job.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class CancelJobExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 

            try
            {
                // Cancel a Job
                CloudJob result = apiInstance.CancelJob(owner, name, jobId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.CancelJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string

Return type

CloudJob

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateJob

CreatedContent CreateJob (string owner, string name, Job job, string authorization = null, string xPollinationToken = null)

Schedule a job

Create a new job.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class CreateJobExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var job = new Job(); // Job | 
            var authorization = authorization_example;  // string |  (optional) 
            var xPollinationToken = xPollinationToken_example;  // string |  (optional) 

            try
            {
                // Schedule a job
                CreatedContent result = apiInstance.CreateJob(owner, name, job, authorization, xPollinationToken);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.CreateJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Notes
owner	string
name	string
job	Job
authorization	string	[optional]
xPollinationToken	string	[optional]

Return type

CreatedContent

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteJob

AnyType DeleteJob (string owner, string name, string jobId)

Delete a Job

Delete a job.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class DeleteJobExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 

            try
            {
                // Delete a Job
                AnyType result = apiInstance.DeleteJob(owner, name, jobId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.DeleteJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string

Return type

AnyType

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadJobArtifact

AnyType DownloadJobArtifact (string owner, string name, string jobId, string path = null)

Download an artifact from the job folder

Get a download link for an artifact in a job folder

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class DownloadJobArtifactExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 
            var path = path_example;  // string | The path to an file within a project folder (optional) 

            try
            {
                // Download an artifact from the job folder
                AnyType result = apiInstance.DownloadJobArtifact(owner, name, jobId, path);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.DownloadJobArtifact: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string
path	string	The path to an file within a project folder	[optional]

Return type

AnyType

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retrieved	-
403	Access forbidden	-
500	Server error	-
400	Invalid request	-
404	Not found	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetJob

CloudJob GetJob (string owner, string name, string jobId)

Get a Job

Retrieve a job.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class GetJobExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 

            try
            {
                // Get a Job
                CloudJob result = apiInstance.GetJob(owner, name, jobId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.GetJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string

Return type

CloudJob

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retrieved	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListJobs

CloudJobList ListJobs (string owner, string name, List ids = null, JobStatusEnum? status = null, DateTime? createdAfter = null, DateTime? createdBefore = null, int? page = null, int? perPage = null)

List Jobs

Retrieve a list of jobs.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class ListJobsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var ids = new List<string>(); // List<string> |  (optional) 
            var status = ;  // JobStatusEnum? |  (optional) 
            var createdAfter = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var createdBefore = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var page = 56;  // int? | Page number starting from 1 (optional)  (default to 1)
            var perPage = 56;  // int? | Number of items per page (optional)  (default to 25)

            try
            {
                // List Jobs
                CloudJobList result = apiInstance.ListJobs(owner, name, ids, status, createdAfter, createdBefore, page, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.ListJobs: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
ids	List<string>		[optional]
status	JobStatusEnum?		[optional]
createdAfter	DateTime?		[optional]
createdBefore	DateTime?		[optional]
page	int?	Page number starting from 1	[optional] [default to 1]
perPage	int?	Number of items per page	[optional] [default to 25]

Return type

CloudJobList

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retrieved	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryJob

CloudJob RetryJob (string owner, string name, string jobId, RetryConfig retryConfig)

Retry failed runs for a Job

Retry failed runs for a job.

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class RetryJobExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 
            var retryConfig = new RetryConfig(); // RetryConfig | 

            try
            {
                // Retry failed runs for a Job
                CloudJob result = apiInstance.RetryJob(owner, name, jobId, retryConfig);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.RetryJob: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string
retryConfig	RetryConfig

Return type

CloudJob

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchJobFolder

FileMetaList SearchJobFolder (string owner, string name, string jobId, List path = null, int? page = null, int? perPage = null)

List files/folders in a job folder

Retrieve a list of artifacts in a job folder

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class SearchJobFolderExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost";
            // Configure API key authorization: APIKeyAuth
            Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
            // Configure HTTP bearer authorization: JWTAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new JobsApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var name = name_example;  // string | 
            var jobId = jobId_example;  // string | 
            var path = new List<string>(); // List<string> | The path to an file within a project folder (optional) 
            var page = 56;  // int? | Page number starting from 1 (optional)  (default to 1)
            var perPage = 56;  // int? | Number of items per page (optional)  (default to 25)

            try
            {
                // List files/folders in a job folder
                FileMetaList result = apiInstance.SearchJobFolder(owner, name, jobId, path, page, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling JobsApi.SearchJobFolder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
owner	string
name	string
jobId	string
path	List<string>	The path to an file within a project folder	[optional]
page	int?	Page number starting from 1	[optional] [default to 1]
perPage	int?	Number of items per page	[optional] [default to 25]

Return type

FileMetaList

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Retrieved	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

JobsApi.md

Latest commit

History

JobsApi.md

File metadata and controls

PollinationSDK.Api.JobsApi

CancelJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DownloadJobArtifact

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListJobs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetryJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SearchJobFolder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details