Documentation for PyPortal.JobResult

Module for Cloud Portal job results.

DownloadType

Result download type

Attributes:

Name	Type	Description
FACEWARE_ANALYZER_PROJECT		Faceware Analyzer Project
RETARGETING_FILE		Faceware Retargeting File
CONTROL_DATA		Faceware Animation Controls Data as JSON

JobResult

JobResult(
    project_id: str,
    id: str,
    status: Optional[JobStatus] = None,
    extended_status: Optional[str] = None,
    progress: Optional[int] = None,
    processing_seconds: Optional[float] = None,
)

A class encapsulating Cloud Portal job result.

Not intended to be initalized directly. Will be added as a property to the submitted/processed jobs.

Initialize JobResult.

Parameters:

Name	Type	Description	Default
project_id	str	The identifier for the project within the organization.	required
id	str	The identifier of the job.	required
status	Optional[JobStatus]	The current job status.	None
extended_status	Optional[str]	The extended status explanation.	None
progress	Optional[int]	The current job progress.	None
processing_seconds	Optional[float]	The number of processing seconds.	None

download_analyzer_file async

download_analyzer_file(absolute_file_name) -> bool

Download analyzer file.

download_control_data async

download_control_data(absolute_file_name) -> bool

Download control data.

download_retargeting_file async

download_retargeting_file(absolute_file_name) -> bool

Download retargeting file.

download_validation_video async

download_validation_video(absolute_file_name) -> bool

Download validation_video.

get_progress async

get_progress()

Get current job progress.

get_status async

get_status()

Get current job status.

JobStatus

Job status type

Attributes:

Name	Type	Description
IN_PROGRESS		Job is actively being processed.
QUEUED		Job is waiting to be processed.
COMPLETED		Job has finished being processed and results are ready to download.
FAILED		Job has failed processing.
CANCELED		Job has been canceled