temporalio.client.NexusOperationExecutionDescription

class documentation

class NexusOperationExecutionDescription(NexusOperationExecution): (source)

View In Hierarchy

Detailed information about a standalone Nexus operation execution.

Warning

This API is experimental and unstable.

Async Method static_details Gets the general fixed details for this Nexus operation execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.
Async Method static_summary Gets the single-line fixed summary for this Nexus operation execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.
Class Variable attempt Current attempt number.
Class Variable blocked_reason Reason the operation is blocked, if any.
Class Variable cancellation_info Cancellation info if cancellation was requested.
Class Variable expiration_time Scheduled time plus schedule_to_close_timeout.
Class Variable identity Identity of the client that started this operation.
Class Variable last_attempt_complete_time Time when the last attempt completed.
Class Variable last_attempt_failure Failure from the last failed attempt, if any.
Class Variable next_attempt_schedule_time Time when the next attempt will be scheduled.
Class Variable operation_token Operation token is only set for asynchronous operations after a successful start_operation call.
Class Variable raw_description Underlying protobuf description info.
Class Variable request_id Server-generated request ID used as an idempotency token.
Class Variable schedule_to_close_timeout Schedule-to-close timeout for this operation.
Class Variable schedule_to_start_timeout Schedule-to-start timeout for this operation.
Class Variable start_to_close_timeout Start-to-close timeout for this operation.
Class Variable state More detailed breakdown if status is NexusOperationExecutionStatus.RUNNING.
Async Class Method _from_execution_info Create from raw proto nexus operation execution info.
Async Method _decode_metadata Internal method to decode metadata lazily.
Class Variable _data_converter Undocumented
Instance Variable _metadata_decoded Undocumented
Instance Variable _static_details Undocumented
Instance Variable _static_summary Undocumented

Inherited from NexusOperationExecution:

Class Variable close_time Time the operation reached a terminal status, if closed.
Class Variable endpoint Endpoint name.
Class Variable execution_duration Duration from scheduled to close time, only populated if closed.
Class Variable operation Operation name.
Class Variable operation_id Unique identifier of this operation.
Class Variable raw_info Underlying protobuf info.
Class Variable run_id Run ID of the standalone Nexus operation.
Class Variable schedule_time Time the operation was originally scheduled.
Class Variable search_attributes Current set of search attributes if any.
Class Variable service Service name.
Class Variable state_transition_count Number of state transitions.
Class Variable status Current status of the operation.
Class Method _from_raw_info Create from raw proto nexus operation list info.
async def static_details(self) -> str | None: (source)

Gets the general fixed details for this Nexus operation execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

async def static_summary(self) -> str | None: (source)

Gets the single-line fixed summary for this Nexus operation execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

attempt: int = (source)

Current attempt number.

blocked_reason: str | None = (source)

Reason the operation is blocked, if any.

cancellation_info: NexusOperationExecutionCancellationInfo | None = (source)

Cancellation info if cancellation was requested.

expiration_time: datetime | None = (source)

Scheduled time plus schedule_to_close_timeout.

identity: str = (source)

Identity of the client that started this operation.

last_attempt_complete_time: datetime | None = (source)

Time when the last attempt completed.

last_attempt_failure: BaseException | None = (source)

Failure from the last failed attempt, if any.

next_attempt_schedule_time: datetime | None = (source)

Time when the next attempt will be scheduled.

operation_token: str | None = (source)

Operation token is only set for asynchronous operations after a successful start_operation call.

raw_description: temporalio.api.nexus.v1.NexusOperationExecutionInfo = (source)

Underlying protobuf description info.

request_id: str = (source)

Server-generated request ID used as an idempotency token.

schedule_to_close_timeout: timedelta | None = (source)

Schedule-to-close timeout for this operation.

schedule_to_start_timeout: timedelta | None = (source)

Schedule-to-start timeout for this operation.

start_to_close_timeout: timedelta | None = (source)

Start-to-close timeout for this operation.

state: temporalio.common.PendingNexusOperationExecutionState = (source)

More detailed breakdown if status is NexusOperationExecutionStatus.RUNNING.

async def _from_execution_info(cls, info: temporalio.api.nexus.v1.NexusOperationExecutionInfo, data_converter: temporalio.converter.DataConverter) -> Self: (source)

Create from raw proto nexus operation execution info.

async def _decode_metadata(self): (source)

Internal method to decode metadata lazily.

_data_converter: temporalio.converter.DataConverter = (source)

Undocumented

_metadata_decoded: bool = (source)

Undocumented

_static_details: str | None = (source)

Undocumented

_static_summary: str | None = (source)

Undocumented