jobs#

Module Contents#

Classes#

API#

class jobs.AsyncJobsResource(client: nemo_platform._client.AsyncNeMoPlatform)#

Bases: nemo_platform._resource.AsyncAPIResource

Initialization

async cancel(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
async create(
*,
workspace: str | None = None,
platform_spec: nemo_platform.types.platform_job_spec_param.PlatformJobSpecParam,
source: str,
spec: Dict[str, object],
custom_fields: Dict[str, object] | nemo_platform._types.Omit = omit,
description: str | nemo_platform._types.Omit = omit,
name: str | nemo_platform._types.Omit = omit,
ownership: Dict[str, object] | nemo_platform._types.Omit = omit,
project: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
async delete(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) None#
get_logs(
name: str,
*,
workspace: str | None = None,
attempt_id: int | nemo_platform._types.Omit = omit,
limit: int | nemo_platform._types.Omit = omit,
page_cursor: str | nemo_platform._types.Omit = omit,
step_id: str | nemo_platform._types.Omit = omit,
task_id: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform._base_client.AsyncPaginator[nemo_platform.types.shared.platform_job_log.PlatformJobLog, nemo_platform.pagination.AsyncLogsPagination[nemo_platform.types.shared.platform_job_log.PlatformJobLog]]#
async get_status(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.shared.platform_job_status_response.PlatformJobStatusResponse#
list(
*,
workspace: str | None = None,
filter: nemo_platform.types.platform_jobs_list_filter_param.PlatformJobsListFilterParam | nemo_platform._types.Omit = omit,
page: int | nemo_platform._types.Omit = omit,
page_size: int | nemo_platform._types.Omit = omit,
search: nemo_platform.types.platform_jobs_search_param.PlatformJobsSearchParam | nemo_platform._types.Omit = omit,
sort: nemo_platform.types.platform_job_sort_field.PlatformJobSortField | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform._base_client.AsyncPaginator[nemo_platform.types.platform_job_response.PlatformJobResponse, nemo_platform.pagination.AsyncDefaultPagination[nemo_platform.types.platform_job_response.PlatformJobResponse]]#
async list_execution_profiles(
*,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.job_list_execution_profiles_response.JobListExecutionProfilesResponse#
async pause(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
property results: results.AsyncResultsResource#
async resume(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
async retrieve(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
property steps: steps.AsyncStepsResource#
property tasks: tasks.AsyncTasksResource#
async update_status_details(
name: str,
*,
workspace: str | None = None,
body: Dict[str, object],
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) object#
property with_raw_response: jobs.AsyncJobsResourceWithRawResponse#
property with_streaming_response: jobs.AsyncJobsResourceWithStreamingResponse#
class jobs.AsyncJobsResourceWithRawResponse(jobs: jobs.AsyncJobsResource)#

Initialization

property results: results.AsyncResultsResourceWithRawResponse#
property steps: steps.AsyncStepsResourceWithRawResponse#
property tasks: tasks.AsyncTasksResourceWithRawResponse#
class jobs.AsyncJobsResourceWithStreamingResponse(jobs: jobs.AsyncJobsResource)#

Initialization

property results: results.AsyncResultsResourceWithStreamingResponse#
property steps: steps.AsyncStepsResourceWithStreamingResponse#
property tasks: tasks.AsyncTasksResourceWithStreamingResponse#
class jobs.JobsResource(client: nemo_platform._client.NeMoPlatform)#

Bases: nemo_platform._resource.SyncAPIResource

Initialization

cancel(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
create(
*,
workspace: str | None = None,
platform_spec: nemo_platform.types.platform_job_spec_param.PlatformJobSpecParam,
source: str,
spec: Dict[str, object],
custom_fields: Dict[str, object] | nemo_platform._types.Omit = omit,
description: str | nemo_platform._types.Omit = omit,
name: str | nemo_platform._types.Omit = omit,
ownership: Dict[str, object] | nemo_platform._types.Omit = omit,
project: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
delete(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) None#
get_logs(
name: str,
*,
workspace: str | None = None,
attempt_id: int | nemo_platform._types.Omit = omit,
limit: int | nemo_platform._types.Omit = omit,
page_cursor: str | nemo_platform._types.Omit = omit,
step_id: str | nemo_platform._types.Omit = omit,
task_id: str | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.pagination.SyncLogsPagination[nemo_platform.types.shared.platform_job_log.PlatformJobLog]#
get_status(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.shared.platform_job_status_response.PlatformJobStatusResponse#
list(
*,
workspace: str | None = None,
filter: nemo_platform.types.platform_jobs_list_filter_param.PlatformJobsListFilterParam | nemo_platform._types.Omit = omit,
page: int | nemo_platform._types.Omit = omit,
page_size: int | nemo_platform._types.Omit = omit,
search: nemo_platform.types.platform_jobs_search_param.PlatformJobsSearchParam | nemo_platform._types.Omit = omit,
sort: nemo_platform.types.platform_job_sort_field.PlatformJobSortField | nemo_platform._types.Omit = omit,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.pagination.SyncDefaultPagination[nemo_platform.types.platform_job_response.PlatformJobResponse]#
list_execution_profiles(
*,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.job_list_execution_profiles_response.JobListExecutionProfilesResponse#
pause(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
property results: results.ResultsResource#
resume(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
retrieve(
name: str,
*,
workspace: str | None = None,
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) nemo_platform.types.platform_job_response.PlatformJobResponse#
property steps: steps.StepsResource#
property tasks: tasks.TasksResource#
update_status_details(
name: str,
*,
workspace: str | None = None,
body: Dict[str, object],
extra_headers: nemo_platform._types.Headers | None = None,
extra_query: nemo_platform._types.Query | None = None,
extra_body: nemo_platform._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given,
) object#
property with_raw_response: jobs.JobsResourceWithRawResponse#
property with_streaming_response: jobs.JobsResourceWithStreamingResponse#
class jobs.JobsResourceWithRawResponse(jobs: jobs.JobsResource)#

Initialization

property results: results.ResultsResourceWithRawResponse#
property steps: steps.StepsResourceWithRawResponse#
property tasks: tasks.TasksResourceWithRawResponse#
class jobs.JobsResourceWithStreamingResponse(jobs: jobs.JobsResource)#

Initialization

property results: results.ResultsResourceWithStreamingResponse#
property steps: steps.StepsResourceWithStreamingResponse#
property tasks: tasks.TasksResourceWithStreamingResponse#

Submodules#