rbtools.api.resource.status_update¶

Resource definitions for status updates.

Classes

class rbtools.api.resource.status_update.StatusUpdateGetListParams[source]¶

Bases: BaseGetListParams

Params for the status update list GET operation.

Added in version 6.0.

__firstlineno__ = 127¶

__static_attributes__ = ()¶

change: ForwardRef('int', module='rbtools.api.resource.status_update')¶

The ID of the change description to get status updates for.

service_id: ForwardRef('str', module='rbtools.api.resource.status_update')¶

The service ID to query for.

state: ForwardRef("Literal['pending', 'done-success', 'done-failure', 'error']", module='rbtools.api.resource.status_update')¶

The state to query for.

class rbtools.api.resource.status_update.StatusUpdateItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: ItemResource

Item resource for status updates.

This corresponds to Review Board’s Status Update Resource.

Added in version 6.0.

__firstlineno__ = 32¶

__static_attributes__ = ()¶

description: str¶

A user-visible description of the status update.

extra_data: ResourceExtraDataField¶

Extra data as part of the status update.

get_change(**kwargs: Unpack[BaseGetParams]) → ChangeItemResource[source]¶

Get the change description for this status update.

If a status update is connected to a review request update, this will return the change description.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description item resource.

Return type:

rbtools.api.resource.ChangeItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_review(**kwargs: Unpack[BaseGetParams]) → ReviewItemResource[source]¶

Get the review associated with this status update.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The review item resource.

Return type:

rbtools.api.resource.ReviewItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

id: int¶

The ID of the status update.

service_id: str¶

A unique identifier for the service providing the status update.

state: Literal['pending', 'done-success', 'done-failure', 'error', 'timed-out']¶

The current state of the status update.

summary: str¶

A user-visible short summary of the status update.

timeout: int¶

An optional timeout for pending status updates, measured in seconds.

url: str¶

An optional URL to link to for more details about the status update.

url_text: str¶

The text to use for the link.

class rbtools.api.resource.status_update.StatusUpdateListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[StatusUpdateItemResource]

List resource for status updates.

This corresponds to Review Board’s Status Update List Resource.

Added in version 6.0.

__firstlineno__ = 144¶

__static_attributes__ = ()¶