`nemo_microservices.resources.intake.apps.apps`#

Module Contents#

Classes#

`AppsResource`
`AppsResourceWithRawResponse`
`AppsResourceWithStreamingResponse`
`AsyncAppsResource`
`AsyncAppsResourceWithRawResponse`
`AsyncAppsResourceWithStreamingResponse`

API#

class nemo_microservices.resources.intake.apps.apps.AppsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create( *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | 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, 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, ) → None#

Create a new app.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the app’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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.

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( app_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, ) → None#

Delete an app.

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.intake.app_filter_param.AppFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.app_search_param.AppSearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.app_sort_field.AppSortField | 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.intake.app.App]#

List all apps with filtering and search capabilities.

Args: filter: Filter apps on various criteria.

page: Page number.

page_size: Page size.

search: Search apps using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[name]=chatbot`: searches all apps with 'chatbot' in the name.
  - `?search[namespace]=default`: searches all apps with 'default' in the
    namespace.
  - `?search[description]=support`: searches all apps with 'support' in the
    description.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all apps updated on or
    after the start date

sort: Sort fields for Apps.

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( app_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.intake.app.App#

Get a specific app by namespace and name.

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 tasks: nemo_microservices.resources.intake.apps.tasks.TasksResource#

update( app_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | 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.intake.app.App#

Update an existing app.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the app’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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.

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.intake.apps.apps.AppsResourceWithRawResponse#

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.intake.apps.apps.AppsResourceWithStreamingResponse#

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.intake.apps.apps.AppsResourceWithRawResponse( apps: nemo_microservices.resources.intake.apps.apps.AppsResource, )#

Initialization

property tasks: nemo_microservices.resources.intake.apps.tasks.TasksResourceWithRawResponse#

class nemo_microservices.resources.intake.apps.apps.AppsResourceWithStreamingResponse( apps: nemo_microservices.resources.intake.apps.apps.AppsResource, )#

Initialization

property tasks: nemo_microservices.resources.intake.apps.tasks.TasksResourceWithStreamingResponse#

class nemo_microservices.resources.intake.apps.apps.AsyncAppsResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create( *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | 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, 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, ) → None#

Create a new app.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the app’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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.

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( app_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, ) → None#

Delete an app.

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.intake.app_filter_param.AppFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.app_search_param.AppSearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.app_sort_field.AppSortField | 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.intake.app.App, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.intake.app.App]]#

List all apps with filtering and search capabilities.

Args: filter: Filter apps on various criteria.

page: Page number.

page_size: Page size.

search: Search apps using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[name]=chatbot`: searches all apps with 'chatbot' in the name.
  - `?search[namespace]=default`: searches all apps with 'default' in the
    namespace.
  - `?search[description]=support`: searches all apps with 'support' in the
    description.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all apps updated on or
    after the start date

sort: Sort fields for Apps.

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( app_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.intake.app.App#

Get a specific app by namespace and name.

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 tasks: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResource#

async update( app_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | 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.intake.app.App#

Update an existing app.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the app’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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.

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.intake.apps.apps.AsyncAppsResourceWithRawResponse#

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.intake.apps.apps.AsyncAppsResourceWithStreamingResponse#

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.intake.apps.apps.AsyncAppsResourceWithRawResponse( apps: nemo_microservices.resources.intake.apps.apps.AsyncAppsResource, )#

Initialization

property tasks: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResourceWithRawResponse#

class nemo_microservices.resources.intake.apps.apps.AsyncAppsResourceWithStreamingResponse( apps: nemo_microservices.resources.intake.apps.apps.AsyncAppsResource, )#

Initialization

property tasks: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResourceWithStreamingResponse#

nemo_microservices.resources.intake.apps.apps#

Module Contents#

Classes#

API#

`nemo_microservices.resources.intake.apps.apps`#