The ops.py module

Summary

Classes

Operation

Provides the schema for a single operation in the system.

Enums

OperationState

State of an operation.

Description

Provides the schemas for the operation state and operation.

Module detail

class ops.Operation(/, **data: Any)

Provides the schema for a single operation in the system.

Overview

Attributes

children
description
ended_at
error
id
messages
progress
progress_current
progress_total
queued_at
result
started_at
state
succeeded_on
user_id

Import detail

from ansys.hps.data_transfer.client.models.ops import Operation

Attribute detail

Operation.children: list[str] | None = None

Operation.description: str | None = None

Operation.ended_at: str | None = None

Operation.error: str | None = None

Operation.id: str | None = None

Operation.messages: list[str] | None = None

Operation.progress: float | None = None

Operation.progress_current: int | None = None

Operation.progress_total: int | None = None

Operation.queued_at: str | None = None

Operation.result: Any | None = None

Operation.started_at: str | None = None

Operation.state: OperationState | None = None

Operation.succeeded_on: list[str] | None = None

Operation.user_id: str | None = None

class Operation.OperationState(*args, **kwds)

State of an operation.

Overview

Attributes

Unknown
Queued
Running
Succeeded
Failed

Import detail

from ansys.hps.data_transfer.client.models.ops import OperationState

Attribute detail

OperationState.Unknown = 'unknown'

OperationState.Queued = 'queued'

OperationState.Running = 'running'

OperationState.Succeeded = 'succeeded'

OperationState.Failed = 'failed'