metadata_get_fields

Retrieve a schema for suggested metadata fields

Functions

async pydelfini.delfini_core.api.metadata.metadata_get_fields.asyncio(*, client)[source]

Retrieve a schema for suggested metadata fields

Raises:
  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[MetadataFields]

Parameters:

client (AuthenticatedClient | Client)

Return type:

MetadataFields

async pydelfini.delfini_core.api.metadata.metadata_get_fields.asyncio_detailed(*, client)[source]

Retrieve a schema for suggested metadata fields

Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[MetadataFields, ServerError]]

Parameters:

client (AuthenticatedClient | Client)

Return type:

Response[MetadataFields | ServerError]

pydelfini.delfini_core.api.metadata.metadata_get_fields.sync(*, client)[source]

Retrieve a schema for suggested metadata fields

Raises:
  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[MetadataFields]

Parameters:

client (AuthenticatedClient | Client)

Return type:

MetadataFields

pydelfini.delfini_core.api.metadata.metadata_get_fields.sync_detailed(*, client)[source]

Retrieve a schema for suggested metadata fields

Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[MetadataFields, ServerError]]

Parameters:

client (AuthenticatedClient | Client)

Return type:

Response[MetadataFields | ServerError]