26.219. Class SessionData
Namespace: ArmoniK.Core.Common.Storage
Assembly: ArmoniK.Core.Common.dll
Represents the data associated with a session in the ArmoniK system.
public record SessionData : IEquatable<SessionData>
26.219.1. Inheritance
26.219.2. Implements
26.219.3. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
26.219.4. Extension Methods
26.219.5. Constructors
26.219.5.1. SessionData(string, SessionStatus, bool, bool, DateTime, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, TimeSpan?, IList<string>, TaskOptions)
Represents the data associated with a session in the ArmoniK system.
public SessionData(string SessionId, SessionStatus Status, bool ClientSubmission, bool WorkerSubmission, DateTime CreationDate, DateTime? CancellationDate, DateTime? ClosureDate, DateTime? PurgeDate, DateTime? DeletionDate, DateTime? DeletionTtl, TimeSpan? Duration, IList<string> PartitionIds, TaskOptions Options)
26.219.5.1.1. Parameters
SessionId string
The unique identifier for the session.
Status SessionStatus
The current status of the session.
ClientSubmission bool
Indicates if clients can still submit tasks in the session.
WorkerSubmission bool
Indicates if workers can still submit tasks in the session.
CreationDate DateTime
The date and time when the session was created.
CancellationDate DateTime?
The date and time when the session was canceled, if applicable.
ClosureDate DateTime?
The date and time when the session was closed, if applicable.
PurgeDate DateTime?
The date and time when the session was purged, if applicable.
DeletionDate DateTime?
The date and time when the session was deleted, if applicable.
DeletionTtl DateTime?
The time-to-live for the session deletion, if applicable.
Duration TimeSpan?
The duration of the session, if applicable.
The list of partition IDs associated with the session.
Options TaskOptions
The task options associated with the session.
26.219.5.2. SessionData(string, SessionStatus, IList<string>, TaskOptions)
Initializes a new instance of the
public SessionData(string sessionId, SessionStatus status, IList<string> partitionIds, TaskOptions options)
26.219.5.2.1. Parameters
sessionId string
The unique identifier for the session.
status SessionStatus
The current status of the session.
The list of partition IDs associated with the session.
options TaskOptions
The task options associated with the session.
26.219.5.3. SessionData(SessionData, UpdateDefinition<SessionData>)
Creates a copy of a
public SessionData(SessionData original, UpdateDefinition<SessionData> updates)
26.219.5.3.1. Parameters
original SessionData
The object that will be copied
updates UpdateDefinition<SessionData>
A collection of field selector and their new values
26.219.6. Properties
26.219.6.1. CancellationDate
The date and time when the session was canceled, if applicable.
public DateTime? CancellationDate { get; init; }
26.219.6.1.1. Property Value
26.219.6.2. ClientSubmission
Indicates if clients can still submit tasks in the session.
public bool ClientSubmission { get; init; }
26.219.6.2.1. Property Value
26.219.6.3. ClosureDate
The date and time when the session was closed, if applicable.
public DateTime? ClosureDate { get; init; }
26.219.6.3.1. Property Value
26.219.6.4. CreationDate
The date and time when the session was created.
public DateTime CreationDate { get; init; }
26.219.6.4.1. Property Value
26.219.6.5. DeletionDate
The date and time when the session was deleted, if applicable.
public DateTime? DeletionDate { get; init; }
26.219.6.5.1. Property Value
26.219.6.6. DeletionTtl
The time-to-live for the session deletion, if applicable.
public DateTime? DeletionTtl { get; init; }
26.219.6.6.1. Property Value
26.219.6.7. Duration
The duration of the session, if applicable.
public TimeSpan? Duration { get; init; }
26.219.6.7.1. Property Value
26.219.6.8. Options
The task options associated with the session.
public TaskOptions Options { get; init; }
26.219.6.8.1. Property Value
TaskOptions
26.219.6.9. PartitionIds
The list of partition IDs associated with the session.
public IList<string> PartitionIds { get; init; }
26.219.6.9.1. Property Value
26.219.6.10. PurgeDate
The date and time when the session was purged, if applicable.
public DateTime? PurgeDate { get; init; }
26.219.6.10.1. Property Value
26.219.6.11. SessionId
The unique identifier for the session.
public string SessionId { get; init; }
26.219.6.11.1. Property Value
26.219.6.12. Status
The current status of the session.
public SessionStatus Status { get; init; }
26.219.6.12.1. Property Value
26.219.6.13. WorkerSubmission
Indicates if workers can still submit tasks in the session.
public bool WorkerSubmission { get; init; }