client.component

Generated methods for the component namespace. Sync owner: WarmHubClient.component. Async owner: AsyncWarmHubClient.component.

Synchronous methods

`get`

get(org_name: str, repo_name: str, component_ref: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ComponentDetail

component.get — query component.get.

`history`

history(org_name: str, repo_name: str, *, component_ref: str | Unset = UNSET, limit: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ComponentHistoryResult

component.history — query component.history.

`install`

install(org_name: str, repo_name: str, component_ref: str, *, submission_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ComponentInstallResult

component.install — mutate component.install.

`list`

list(org_name: str, repo_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ComponentListResult

component.list — query component.list.

`list_iter`

list_iter(org_name: str, repo_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every component installed in the repository, page by page.

`search`

search(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GlobalSearchResult

component.search — query component.search.

`search_iter`

search_iter(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every registered component the caller can see, page by page.

Global, not repository-scoped: public components across all orgs plus private ones the caller can read. Use list_iter for the components installed in one repository.

`uninstall`

uninstall(org_name: str, repo_name: str, component_ref: str, *, submission_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ComponentUninstallResult

component.uninstall — mutate component.uninstall.

Asynchronous methods