nemo_microservices.resources.beta.audit.configs#

Module Contents#

Classes#

API#

class nemo_microservices.resources.beta.audit.configs.AsyncConfigsResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create(
*,
id: str | nemo_microservices._types.Omit = omit,
created_at: str | datetime.datetime | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
entity_id: str | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
plugins: nemo_microservices.types.beta.audit.audit_plugins_data_param.AuditPluginsDataParam | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
reporting: nemo_microservices.types.beta.audit.audit_report_data_param.AuditReportDataParam | nemo_microservices._types.Omit = omit,
run: nemo_microservices.types.beta.audit.audit_run_data_param.AuditRunDataParam | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
system: nemo_microservices.types.beta.audit.audit_system_data_param.AuditSystemDataParam | nemo_microservices._types.Omit = omit,
type_prefix: str | nemo_microservices._types.Omit = omit,
updated_at: str | datetime.datetime | 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.beta.audit.audit_config.AuditConfig#

Post Config

Args: id: The ID of the entity.

With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [-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.

entity_id: The entity id. If first version, it will match version id

name: The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

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 delete(
config_name: str,
*,
namespace: 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.shared.delete_response.DeleteResponse#

Delete Config

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 list(
*,
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.beta.audit.config_list_response.ConfigListResponse#

Get Configs

list_versions(
config_name: str,
*,
namespace: str,
filter: nemo_microservices.types.beta.audit.audit_config_filter_param.AuditConfigFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.beta.audit.audit_config_version_sort_field.AuditConfigVersionSortField | 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.beta.audit.audit_config.AuditConfig, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.beta.audit.audit_config.AuditConfig]]#

Get all historical versions of a config

Args: filter: Filter versions on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in descending 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(
config_name: str,
*,
namespace: 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.beta.audit.audit_config.AuditConfig#

Get Config

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(
config_name: str,
*,
namespace: str,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
plugins: nemo_microservices.types.beta.audit.audit_plugins_data_param.AuditPluginsDataParam | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
reporting: nemo_microservices.types.beta.audit.audit_report_data_param.AuditReportDataParam | nemo_microservices._types.Omit = omit,
run: nemo_microservices.types.beta.audit.audit_run_data_param.AuditRunDataParam | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
system: nemo_microservices.types.beta.audit.audit_system_data_param.AuditSystemDataParam | 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.beta.audit.audit_config.AuditConfig#

Update Config

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

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.

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.beta.audit.configs.AsyncConfigsResourceWithRawResponse#

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.beta.audit.configs.AsyncConfigsResourceWithStreamingResponse#

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.beta.audit.configs.AsyncConfigsResourceWithRawResponse(
configs: nemo_microservices.resources.beta.audit.configs.AsyncConfigsResource,
)#

Initialization

class nemo_microservices.resources.beta.audit.configs.AsyncConfigsResourceWithStreamingResponse(
configs: nemo_microservices.resources.beta.audit.configs.AsyncConfigsResource,
)#

Initialization

class nemo_microservices.resources.beta.audit.configs.ConfigsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create(
*,
id: str | nemo_microservices._types.Omit = omit,
created_at: str | datetime.datetime | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
entity_id: str | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
plugins: nemo_microservices.types.beta.audit.audit_plugins_data_param.AuditPluginsDataParam | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
reporting: nemo_microservices.types.beta.audit.audit_report_data_param.AuditReportDataParam | nemo_microservices._types.Omit = omit,
run: nemo_microservices.types.beta.audit.audit_run_data_param.AuditRunDataParam | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
system: nemo_microservices.types.beta.audit.audit_system_data_param.AuditSystemDataParam | nemo_microservices._types.Omit = omit,
type_prefix: str | nemo_microservices._types.Omit = omit,
updated_at: str | datetime.datetime | 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.beta.audit.audit_config.AuditConfig#

Post Config

Args: id: The ID of the entity.

With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [-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.

entity_id: The entity id. If first version, it will match version id

name: The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

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

delete(
config_name: str,
*,
namespace: 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.shared.delete_response.DeleteResponse#

Delete Config

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(
*,
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.beta.audit.config_list_response.ConfigListResponse#

Get Configs

list_versions(
config_name: str,
*,
namespace: str,
filter: nemo_microservices.types.beta.audit.audit_config_filter_param.AuditConfigFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.beta.audit.audit_config_version_sort_field.AuditConfigVersionSortField | 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.beta.audit.audit_config.AuditConfig]#

Get all historical versions of a config

Args: filter: Filter versions on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in descending 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(
config_name: str,
*,
namespace: 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.beta.audit.audit_config.AuditConfig#

Get Config

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(
config_name: str,
*,
namespace: str,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
plugins: nemo_microservices.types.beta.audit.audit_plugins_data_param.AuditPluginsDataParam | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
reporting: nemo_microservices.types.beta.audit.audit_report_data_param.AuditReportDataParam | nemo_microservices._types.Omit = omit,
run: nemo_microservices.types.beta.audit.audit_run_data_param.AuditRunDataParam | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
system: nemo_microservices.types.beta.audit.audit_system_data_param.AuditSystemDataParam | 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.beta.audit.audit_config.AuditConfig#

Update Config

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

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.

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.beta.audit.configs.ConfigsResourceWithRawResponse#

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.beta.audit.configs.ConfigsResourceWithStreamingResponse#

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.beta.audit.configs.ConfigsResourceWithRawResponse(
configs: nemo_microservices.resources.beta.audit.configs.ConfigsResource,
)#

Initialization

class nemo_microservices.resources.beta.audit.configs.ConfigsResourceWithStreamingResponse(
configs: nemo_microservices.resources.beta.audit.configs.ConfigsResource,
)#

Initialization