client.action

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

Synchronous methods

`acquire_lease`

acquire_lease(org_name: str, repo_name: str, subscription_name: str, holder_id: str, holder_type: Literal['sdk', 'cli'], *, grace_ms: float | Unset = UNSET, ttl_ms: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ActionLeaseAcquire0 | ActionLeaseAcquire1

action.acquireLease — mutate action.acquireLease.

`claim_delivery`

claim_delivery(org_name: str, repo_name: str, holder_id: str, *, run_id: str | Unset = UNSET, delivery_id: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Claim one action delivery for processing.

`complete_delivery`

complete_delivery(org_name: str, repo_name: str, holder_id: str, *, run_id: str | Unset = UNSET, delivery_id: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Mark one claimed action delivery as complete.

`get_run_attempts`

get_run_attempts(org_name: str, repo_name: str, run_id: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[ActionAttempt, ...]

action.getRunAttempts — query action.getRunAttempts.

`heartbeat_lease`

heartbeat_lease(org_name: str, repo_name: str, subscription_name: str, holder_id: str, ttl_ms: float | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ActionLeaseOp0 | ActionLeaseOp1

action.heartbeatLease — mutate action.heartbeatLease.

`latest_runs`

latest_runs(org_name: str, repo_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[ActionRun, ...]

action.latestRuns — query action.latestRuns.

`list_notifications`

list_notifications(org_name: str, repo_name: str, *, since: float | Unset = UNSET, limit: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[ActionNotification, ...]

action.listNotifications — query action.listNotifications.

`list_runs`

list_runs(org_name: str, repo_name: str, *, run_id: str | Unset = UNSET, subscription_name: str | Unset = UNSET, status: Literal['pending', 'running', 'processing', 'retry_wait', 'succeeded', 'suppressed', 'failed_terminal', 'dead_letter'] | Unset = UNSET, outcome: Literal['succeeded', 'failed'] | Unset = UNSET, since: float | Unset = UNSET, cursor: str | Unset = UNSET, limit: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ActionListRunsResult

action.listRuns — query action.listRuns.

`list_runs_iter`

list_runs_iter(org_name: str, repo_name: str, *, run_id: str | Unset = UNSET, subscription_name: str | Unset = UNSET, status: ActionRunStatus | Unset = UNSET, outcome: Literal['succeeded', 'failed'] | Unset = UNSET, since: float | Unset = UNSET, cursor: str | Unset = UNSET, limit: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every action run, newest first, page by page.

status and outcome are mutually exclusive, and so are since and cursor: since is sent on the initial request only, then dropped, because the window rides in the cursor from the second page on. Resuming from a saved cursor therefore never sends since.

`live_feed`

live_feed(org_name: str, repo_name: str, subscription_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) -> ActionLiveFeedResult

action.liveFeed — query action.liveFeed.

`live_feed_iter`

live_feed_iter(org_name: str, repo_name: str, subscription_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 delivery-feed entry for one subscription, page by page.

This walks a live feed to exhaustion; it does not poll for new entries once the cursor runs out. Re-call the factory to pick up later ones.

`release_lease`

release_lease(org_name: str, repo_name: str, subscription_name: str, holder_id: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ActionLeaseOp0 | ActionLeaseOp1

action.releaseLease — mutate action.releaseLease.

`run_stats`

run_stats(org_name: str, repo_name: str, *, subscription_name: str | Unset = UNSET, since: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ActionRunStats

action.runStats — query action.runStats.

Asynchronous methods