Models

class servicex.models.ResultDestination(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Direct the output to object store or posix volume

object_store = 'object-store'

volume = 'volume'

pydantic model servicex.models.ResultFile

Bases: BaseModel

Record reporting the properties of a transformed file result

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field filename: str [Required]

field size: int [Required]

field extension: str [Required]

class servicex.models.ResultFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Specify the file format for the generated output

parquet = 'parquet'

root_ttree = 'root-file'

class servicex.models.Status(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Status of a submitted transform

canceled = 'Canceled'

complete = 'Complete'

fatal = 'Fatal'

looking = 'Lookup'

pending = 'Pending Lookup'

running = 'Running'

submitted = 'Submitted'

pydantic model servicex.models.TransformRequest

Bases: BaseModel

Transform request sent to ServiceX

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field title: str | None = None

field did: str | None = None

field file_list: List[str] | None = None (alias 'file-list')

field selection: str [Required]

field image: str | None = None

field codegen: str [Required]

field tree_name: str | None = None (alias 'tree-name')

field result_destination: ResultDestination [Required]

field result_format: ResultFormat [Required]

compute_hash()

Compute a hash for this submission. Only include properties that impact the result so we have maximal ability to reuse transforms

Returns:

SHA256 hash of request

pydantic model servicex.models.TransformStatus

Bases: BaseModel

Status object returned by servicex

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Validators:

• parse_finish_time » finish_time

field request_id: str [Required]

field did: str [Required]

field title: str | None = None

field selection: str [Required]

field tree_name: str | None [Required]

field image: str [Required]

field result_destination: ResultDestination [Required]

field result_format: ResultFormat [Required]

field generated_code_cm: str [Required]

field status: Status [Required]

field app_version: str [Required]

field files: int [Required]

field files_completed: int [Required]

field files_failed: int [Required]

field files_remaining: int | None = 0

field submit_time: datetime = None

field finish_time: datetime | None = None

field minio_endpoint: str | None = None

field minio_secured: bool | None = None

field minio_access_key: str | None = None

field minio_secret_key: str | None = None

field log_url: str | None = None

pydantic model servicex.models.TransformedResults

Bases: BaseModel

Returned for a submission. Gives you everything you need to know about a completed transform.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field hash: str [Required]

field title: str [Required]

field codegen: str [Required]

field request_id: str [Required]

field submit_time: datetime [Required]

field data_dir: str [Required]

field file_list: List[str] [Required]

field signed_url_list: List[str] [Required]

field files: int [Required]

field result_format: ResultFormat [Required]

field log_url: str | None = None