Auditor Jobs Resource#

This page documents the Auditor jobs resource classes from the nemo_microservices package.

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

Bases: SyncAPIResource

property results: ResultsResource#

property with_raw_response: 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: 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

Submit job

Parameters:

config – A reference to AuditConfig.
target – A reference to AuditTarget.
id – The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [<prefix>-base58(uuid4())].
created_at – Timestamp for when the entity was created.
custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
schema_version – The version of the schema for the object. Internal use only.
type_prefix – The type prefix of the entity ID. If not specified, it will be inferred from the entity type name, but this will likely result in long prefixes.
updated_at – Timestamp for when the entity was last updated.
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( *, extra_headers: Headers | None = None, extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) → JobListResponse#: List jobs

Cancel running job

Parameters:

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 job logs

Parameters:

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 job status

Parameters:

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

Pause running job

Parameters:

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

Resume paused job

Parameters:

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_from_dict(data: dict[str, object]) → object#

class nemo_microservices.resources.beta.audit.jobs.AsyncJobsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property results: AsyncResultsResource#

property with_raw_response: 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: 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

Submit job

Parameters:

config – A reference to AuditConfig.
target – A reference to AuditTarget.
id – The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [<prefix>-base58(uuid4())].
created_at – Timestamp for when the entity was created.
custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
schema_version – The version of the schema for the object. Internal use only.
type_prefix – The type prefix of the entity ID. If not specified, it will be inferred from the entity type name, but this will likely result in long prefixes.
updated_at – Timestamp for when the entity was last updated.
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( *, extra_headers: Headers | None = None, extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) → JobListResponse#: List jobs

Cancel running job

Parameters:

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 job logs

Parameters:

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 job status

Parameters:

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

Pause running job

Parameters:

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

Resume paused job

Parameters:

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_from_dict(data: dict[str, object]) → object#