`nemo_microservices.resources.jobs.jobs`#

Module Contents#

Classes#

`AsyncJobsResource`
`AsyncJobsResourceWithRawResponse`
`AsyncJobsResourceWithStreamingResponse`
`JobsResource`
`JobsResourceWithRawResponse`
`JobsResourceWithStreamingResponse`

API#

class nemo_microservices.resources.jobs.jobs.AsyncJobsResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async cancel( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Cancel Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async create( *, platform_spec: nemo_microservices.types.jobs.platform_job_spec_param.PlatformJobSpecParam, source: str, spec: Dict[str, object], custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: Dict[str, object] | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Create Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async delete( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → None#

Delete Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

get_logs( job_id: str, *, limit: int | nemo_microservices._types.Omit = omit, page_cursor: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices._base_client.AsyncPaginator[nemo_microservices.types.jobs.platform_job_log.PlatformJobLog, nemo_microservices.pagination.AsyncLogsPagination[nemo_microservices.types.jobs.platform_job_log.PlatformJobLog]]#

Page Job Logs

Args: limit: Maximum number of logs to return

page_cursor: Page cursor

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async get_status( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job_status_response.PlatformJobStatusResponse#

Get Job Status

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

List Jobs

Args: filter: Filter jobs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async list_execution_profiles( *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.job_list_execution_profiles_response.JobListExecutionProfilesResponse#: Get all currently configured execution profiles.

async pause( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Pause Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property results: nemo_microservices.resources.jobs.results.AsyncResultsResource#

async resume( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Resume Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async retrieve( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Get Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property steps: nemo_microservices.resources.jobs.steps.AsyncStepsResource#

property tasks: nemo_microservices.resources.jobs.tasks.AsyncTasksResource#

async update_status_details( job_id: str, *, body: object, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → object#

Update Job Status Details

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.jobs.jobs.AsyncJobsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.jobs.jobs.AsyncJobsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.jobs.jobs.AsyncJobsResourceWithRawResponse( jobs: nemo_microservices.resources.jobs.jobs.AsyncJobsResource, )#

Initialization

property results: nemo_microservices.resources.jobs.results.AsyncResultsResourceWithRawResponse#

property steps: nemo_microservices.resources.jobs.steps.AsyncStepsResourceWithRawResponse#

property tasks: nemo_microservices.resources.jobs.tasks.AsyncTasksResourceWithRawResponse#

class nemo_microservices.resources.jobs.jobs.AsyncJobsResourceWithStreamingResponse( jobs: nemo_microservices.resources.jobs.jobs.AsyncJobsResource, )#

Initialization

property results: nemo_microservices.resources.jobs.results.AsyncResultsResourceWithStreamingResponse#

property steps: nemo_microservices.resources.jobs.steps.AsyncStepsResourceWithStreamingResponse#

property tasks: nemo_microservices.resources.jobs.tasks.AsyncTasksResourceWithStreamingResponse#

class nemo_microservices.resources.jobs.jobs.JobsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

cancel( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Cancel Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

create( *, platform_spec: nemo_microservices.types.jobs.platform_job_spec_param.PlatformJobSpecParam, source: str, spec: Dict[str, object], custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: Dict[str, object] | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Create Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

delete( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → None#

Delete Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

get_logs( job_id: str, *, limit: int | nemo_microservices._types.Omit = omit, page_cursor: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.pagination.SyncLogsPagination[nemo_microservices.types.jobs.platform_job_log.PlatformJobLog]#

Page Job Logs

Args: limit: Maximum number of logs to return

page_cursor: Page cursor

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

get_status( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job_status_response.PlatformJobStatusResponse#

Get Job Status

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

list( *, filter: nemo_microservices.types.jobs.platform_jobs_list_filter_param.PlatformJobsListFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.jobs.platform_job_sort_field.PlatformJobSortField | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.pagination.SyncDefaultPagination[nemo_microservices.types.jobs.platform_job.PlatformJob]#

List Jobs

Args: filter: Filter jobs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

list_execution_profiles( *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.job_list_execution_profiles_response.JobListExecutionProfilesResponse#: Get all currently configured execution profiles.

pause( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Pause Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property results: nemo_microservices.resources.jobs.results.ResultsResource#

resume( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Resume Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

retrieve( job_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.jobs.platform_job.PlatformJob#

Get Job

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property steps: nemo_microservices.resources.jobs.steps.StepsResource#

property tasks: nemo_microservices.resources.jobs.tasks.TasksResource#

update_status_details( job_id: str, *, body: object, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → object#

Update Job Status Details

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.jobs.jobs.JobsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.jobs.jobs.JobsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.jobs.jobs.JobsResourceWithRawResponse( jobs: nemo_microservices.resources.jobs.jobs.JobsResource, )#

Initialization

property results: nemo_microservices.resources.jobs.results.ResultsResourceWithRawResponse#

property steps: nemo_microservices.resources.jobs.steps.StepsResourceWithRawResponse#

property tasks: nemo_microservices.resources.jobs.tasks.TasksResourceWithRawResponse#

class nemo_microservices.resources.jobs.jobs.JobsResourceWithStreamingResponse( jobs: nemo_microservices.resources.jobs.jobs.JobsResource, )#

Initialization

property results: nemo_microservices.resources.jobs.results.ResultsResourceWithStreamingResponse#

property steps: nemo_microservices.resources.jobs.steps.StepsResourceWithStreamingResponse#

property tasks: nemo_microservices.resources.jobs.tasks.TasksResourceWithStreamingResponse#

nemo_microservices.resources.jobs.jobs#

Module Contents#

Classes#

API#

`nemo_microservices.resources.jobs.jobs`#