Class JobBase
- Namespace
- Excalibur.Application.Requests.Jobs
- Assembly
- Excalibur.Application.dll
Represents the base implementation for a job in the system.
public abstract class JobBase : IJob, IAmCorrelatable, IAmMultiTenant, IDispatchAction<JobResult>, IDispatchAction, IDispatchMessage
- Inheritance
-
JobBase
- Implements
- Derived
- Inherited Members
Remarks
Initializes a new instance of the JobBase class with the specified correlation ID and tenant ID.
Constructors
JobBase()
Initializes a new instance of the JobBase class with default values.
protected JobBase()
JobBase(Guid, string?)
Represents the base implementation for a job in the system.
protected JobBase(Guid correlationId, string? tenantId = null)
Parameters
correlationIdGuidThe correlation ID for the job.
tenantIdstringThe tenant ID associated with the job. Defaults to TenantDefaults.DefaultTenantId if not provided.
Remarks
Initializes a new instance of the JobBase class with the specified correlation ID and tenant ID.
Properties
ActivityDescription
Gets a description of the job's purpose or functionality.
public virtual string ActivityDescription { get; }
Property Value
- string
The description of the job's purpose or functionality.
Remarks
The description provides additional context about the job and can be used for documentation or debugging.
ActivityDisplayName
Gets a human-readable display name of the job.
public virtual string ActivityDisplayName { get; }
Property Value
- string
The human-readable display name of the job.
Remarks
The display name is suitable for use in logs, dashboards, or other user-facing contexts.
ActivityName
Gets the unique name of the job.
public string ActivityName { get; }
Property Value
- string
The unique name of the job.
Remarks
The name is typically a combination of the namespace and type name, providing a unique identifier for the job.
ActivityType
Gets the type of the activity, which is typically Job for jobs.
public ActivityType ActivityType { get; }
Property Value
- ActivityType
The type of the activity, which is typically Job for jobs.
CorrelationId
Gets the correlation ID for the entity.
public Guid CorrelationId { get; protected init; }
Property Value
- Guid
The correlation ID for the entity.
Headers
Gets the message headers.
public IReadOnlyDictionary<string, object> Headers { get; }
Property Value
- IReadOnlyDictionary<string, object>
A read-only dictionary containing the job's metadata headers.
Id
Gets the unique identifier for this job as a GUID.
public Guid Id { get; protected init; }
Property Value
- Guid
A unique identifier for this job instance.
MessageId
Gets the unique identifier for this job as a string.
public string MessageId { get; }
Property Value
- string
The string representation of the job's unique identifier.
MessageType
Gets the type identifier for this job.
public string MessageType { get; }
Property Value
- string
The fully qualified type name of the job.
TenantId
Gets the tenant identifier associated with the entity.
public string? TenantId { get; protected init; }
Property Value
- string
The tenant identifier associated with the entity.