AnalyzersResource

Analyzer API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(request, idempotency_key=None) -> AnalyzerResponse

Create an analyzer.

paramrequestAnalyzerCreateRequest

Analyzer create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.analyzer.AnalyzerResponse

Created analyzer.

funcget(analyzer_id) -> AnalyzerResponse

Get an analyzer by id.

paramanalyzer_iduuid.UUID

Id of the analyzer.

Returns

kitaru.api_models.v1.analyzer.AnalyzerResponse

Stored analyzer.

funclist(params=None) -> Page[AnalyzerResponse]

List analyzers.

paramparamsAnalyzerListParams | None

= None

Analyzer list params.

Returns

kitaru.api_models.v1.base.Page

Page of analyzers.

funciter(params=None) -> AsyncIterator[AnalyzerResponse]

Iterate over all analyzers.

paramparamsAnalyzerListParams | None

= None

Analyzer list params.

Returns

collections.abc.AsyncIterator

Async iterator over every analyzer.

funcupdate(analyzer_id, request) -> AnalyzerResponse

Update an analyzer.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramrequestAnalyzerUpdateRequest

Analyzer update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.analyzer.AnalyzerResponse

Updated analyzer.

funcdelete(analyzer_id) -> None

Delete an analyzer, cascading its versions.

paramanalyzer_iduuid.UUID

Id of the analyzer.

Returns

None

funccreate_version(analyzer_id, request, idempotency_key=None) -> AnalyzerVersionResponse

Create an analyzer version.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramrequestAnalyzerVersionCreateRequest

Analyzer version create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.analyzer.AnalyzerVersionResponse

Created analyzer version.

funclist_versions(analyzer_id, params=None) -> Page[AnalyzerVersionResponse]

List an analyzer's versions.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramparamsListParams | None

= None

List params.

Returns

kitaru.api_models.v1.base.Page

Page of analyzer versions.

funciter_versions(analyzer_id, params=None) -> AsyncIterator[AnalyzerVersionResponse]

Iterate over all of an analyzer's versions.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramparamsListParams | None

= None

List params.

Returns

collections.abc.AsyncIterator

Async iterator over every analyzer version.

funcget_version(analyzer_id, version) -> AnalyzerVersionResponse

Get an analyzer version by version number.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramversionint

Version number.

Returns

kitaru.api_models.v1.analyzer.AnalyzerVersionResponse

Stored analyzer version.

funcupdate_version(analyzer_id, version, request) -> AnalyzerVersionResponse

Update an analyzer version's display version.

paramanalyzer_iduuid.UUID

Id of the analyzer.

paramversionint

Version number.

paramrequestAnalyzerVersionUpdateRequest

Analyzer version update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.analyzer.AnalyzerVersionResponse

Updated analyzer version.

FunctionsCopy Anchor Link

On this page

Functions