Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::AssetSystem::AssetSystemJobRequest Class Referenceabstract

This Ebus will be used to retrieve all the job related information from AP. More...

#include <EditorAssetSystemAPI.h>

Inherits AZ::EBusTraits.

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual AZ::Outcome< JobInfoContainer > GetAssetJobsInfo (const AZStd::string &sourcePath, const bool escalateJobs)=0
 Retrieve Jobs information for the given source file, setting escalateJobs to true will escalate all queued jobs.
 
virtual AZ::Outcome< JobInfoContainer > GetAssetJobsInfoByAssetID (const AZ::Data::AssetId &assetId, const bool escalateJobs, bool requireFencing)=0
 
virtual AZ::Outcome< JobInfoContainer > GetAssetJobsInfoByJobKey (const AZStd::string &jobKey, const bool escalateJobs)=0
 Retrieve Jobs information for the given jobKey.
 
virtual AZ::Outcome< JobStatus > GetAssetJobsStatusByJobKey (const AZStd::string &jobKey, const bool escalateJobs)=0
 
virtual AZ::Outcome< AZStd::string > GetJobLog (AZ::u64 jobrunkey)=0
 Retrieve the actual log content for a particular job. you can retrieve the run key from the above info function.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 
static const bool LocklessDispatch = true
 

Detailed Description

This Ebus will be used to retrieve all the job related information from AP.

Member Function Documentation

◆ GetAssetJobsInfoByAssetID()

virtual AZ::Outcome< JobInfoContainer > AzToolsFramework::AssetSystem::AssetSystemJobRequest::GetAssetJobsInfoByAssetID ( const AZ::Data::AssetId &  assetId,
const bool  escalateJobs,
bool  requireFencing 
)
pure virtual

Retrieve Jobs information for the given assetId, setting escalteJobs to true will escalate all queued jobs you can also specify whether fencing is required

◆ GetAssetJobsStatusByJobKey()

virtual AZ::Outcome< JobStatus > AzToolsFramework::AssetSystem::AssetSystemJobRequest::GetAssetJobsStatusByJobKey ( const AZStd::string &  jobKey,
const bool  escalateJobs 
)
pure virtual

Retrieve Job Status for the given jobKey. If no jobs are present, return missing, else, if any matching jobs have failed, it will return failed else, if any of the matching jobs are queued, it will return queued else, if any matching jobs are in progress, will return inprogress else it will return the completed job status.

The documentation for this class was generated from the following file: