Iterate over labels

async AsyncCogniteClient.labels.__call__(
chunk_size: int | None = None,
name: str | None = None,
external_id_prefix: str | None = None,
limit: int | None = None,
data_set_ids: int | Sequence[int] | None = None,
data_set_external_ids: str | SequenceNotStr[str] | None = None,
) → AsyncIterator[LabelDefinition] | AsyncIterator[LabelDefinitionList]

Iterate over Labels

Parameters:

  • chunk_size (int | None) – Number of Labels to return in each chunk. Defaults to yielding one Label a time.

  • name (str | None) – returns the label definitions matching that name

  • external_id_prefix (str | None) – filter label definitions with external ids starting with the prefix specified

  • limit (int | None) – Maximum number of label definitions to return. Defaults return all labels.

  • data_set_ids (int | Sequence[int] | None) – return only labels in the data sets with this id / these ids.

  • data_set_external_ids (str | SequenceNotStr[str] | None) – return only labels in the data sets with this external id / these external ids.

Yields:

LabelDefinition | LabelDefinitionList – yields Labels one by one or in chunks.