Entity Projects Resource#

class nemo_microservices.resources.ProjectsResource(client: NeMoMicroservices)#

Bases: SyncAPIResource

property with_raw_response: ProjectsResourceWithRawResponse#

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: ProjectsResourceWithStreamingResponse#

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

create(
*,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
name: str | NotGiven = NOT_GIVEN,
namespace: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → Project#

Create a new project.

Parameters:

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

  • description – The description of the entity.

  • 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.

  • 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(
project_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → Project#

Get Project

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

update(
project_name: str,
*,
namespace: str,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Update project.

Parameters:

  • 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.

  • 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: ProjectFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: ProjectSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → SyncDefaultPagination[Project]#

List all projects.

Parameters:

  • filter – Filter projects 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

delete(
project_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → DeleteResponse#

Delete Project

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.AsyncProjectsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property with_raw_response: AsyncProjectsResourceWithRawResponse#

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: AsyncProjectsResourceWithStreamingResponse#

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

async create(
*,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
name: str | NotGiven = NOT_GIVEN,
namespace: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → Project#

Create a new project.

Parameters:

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

  • description – The description of the entity.

  • 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.

  • 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(
project_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → Project#

Get Project

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

async update(
project_name: str,
*,
namespace: str,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Update project.

Parameters:

  • 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.

  • 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: ProjectFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: ProjectSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → AsyncPaginator[Project, AsyncDefaultPagination[Project]]#

List all projects.

Parameters:

  • filter – Filter projects 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 delete(
project_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → DeleteResponse#

Delete Project

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#