`nemo_microservices.resources.jobs.steps`#

Module Contents#

Classes#

`AsyncStepsResource`
`AsyncStepsResourceWithRawResponse`
`AsyncStepsResourceWithStreamingResponse`
`StepsResource`
`StepsResourceWithRawResponse`
`StepsResourceWithStreamingResponse`

API#

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

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

List job steps with pagination and filtering.

Args: filter: Filter steps 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 retrieve( step_name: str, *, 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_step.PlatformJobStep#

Get Job Step

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 update_status( step_name: str, *, job_id: str, status: nemo_microservices.types.jobs.platform_job_status.PlatformJobStatus, error_details: Dict[str, object] | 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_step.PlatformJobStep#

Update Job Step Status

Args: status: Enumeration of possible job statuses.

  This enum represents the various states a job can be in during its lifecycle,
  from creation to a terminal state.

error_details: Optional error details related to the status update.

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 update_status_details( step_name: str, *, 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 Step 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.steps.AsyncStepsResourceWithRawResponse#

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.steps.AsyncStepsResourceWithStreamingResponse#

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.steps.AsyncStepsResourceWithRawResponse( steps: nemo_microservices.resources.jobs.steps.AsyncStepsResource, )#: Initialization

class nemo_microservices.resources.jobs.steps.AsyncStepsResourceWithStreamingResponse( steps: nemo_microservices.resources.jobs.steps.AsyncStepsResource, )#: Initialization

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

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

list( job_id: str, *, filter: nemo_microservices.types.jobs.platform_job_steps_list_filter_param.PlatformJobStepsListFilterParam | 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_step_with_context.PlatformJobStepWithContext]#

List job steps with pagination and filtering.

Args: filter: Filter steps 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

retrieve( step_name: str, *, 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_step.PlatformJobStep#

Get Job Step

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

update_status( step_name: str, *, job_id: str, status: nemo_microservices.types.jobs.platform_job_status.PlatformJobStatus, error_details: Dict[str, object] | 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_step.PlatformJobStep#

Update Job Step Status

Args: status: Enumeration of possible job statuses.

  This enum represents the various states a job can be in during its lifecycle,
  from creation to a terminal state.

error_details: Optional error details related to the status update.

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

update_status_details( step_name: str, *, 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 Step 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.steps.StepsResourceWithRawResponse#

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.steps.StepsResourceWithStreamingResponse#

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.steps.StepsResourceWithRawResponse( steps: nemo_microservices.resources.jobs.steps.StepsResource, )#: Initialization

class nemo_microservices.resources.jobs.steps.StepsResourceWithStreamingResponse( steps: nemo_microservices.resources.jobs.steps.StepsResource, )#: Initialization

nemo_microservices.resources.jobs.steps#

Module Contents#

Classes#

API#

`nemo_microservices.resources.jobs.steps`#