ChatKittyPlatformAPI.Api.Jobs (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged Jobs
.
Link to this section Summary
Functions
List jobs Returns a page of jobs created for this application
Retrieve a job Returns a job by ID
Link to this section Functions
Link to this function
list_jobs(connection, opts \\ [])
@spec list_jobs( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.PagedModelApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
List jobs Returns a page of jobs created for this application
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :page (integer()): Zero-based page index (0..N)
- :size (integer()): The size of the page to be returned
- :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
- :running (boolean()): Filters for jobs currently running
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
retrieve_job(connection, id, opts \\ [])
@spec retrieve_job(Tesla.Env.client(), integer(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve a job Returns a job by ID
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()): Job ID
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure