Class FileStorageMetadata

Namespace

Monai.Deploy.InformaticsGateway.Api.Storage

Assembly

Monai.Deploy.InformaticsGateway.Api.dll

Provides basic information for a DICOM instance and storage hierarchy/path.

public abstract record FileStorageMetadata : IEquatable<FileStorageMetadata>

Inheritance

object

FileStorageMetadata

Implements

IEquatable<FileStorageMetadata>

Derived

DicomFileStorageMetadata

FhirFileStorageMetadata

Hl7FileStorageMetadata

Constructors

FileStorageMetadata()

DO NOT USE This constructor is intended for JSON serializer. Due to limitation in current version of .NET, the constructor must be public. https://github.com/dotnet/runtime/issues/31511

[JsonConstructor]
protected FileStorageMetadata()

FileStorageMetadata(string, string)

protected FileStorageMetadata(string correlationId, string identifier)

Parameters

correlationId string

identifier string

Properties

CorrelationId

Gets the correlation ID of the file. For SCP received DICOM instances: use internally generated unique association ID. For ACR retrieved DICOM/FHIR files: use the original transaction ID embedded in the request.

[JsonPropertyName("correlationId")]
public string CorrelationId { get; set; }

Property Value

string

DataOrigin

Gets or sets the data origin of this file.

[JsonPropertyName("dataOrigin")]
[JsonInclude]
public DataOrigin DataOrigin { get; }

Property Value

DataOrigin

DataTypeDirectoryName

Gets the root directory name

public abstract string DataTypeDirectoryName { get; }

Property Value

string

DateReceived

Gets or sets the DateTime that the file was received.

[JsonPropertyName("dateReceived")]
public DateTime DateReceived { get; init; }

Property Value

DateTime

File

Gets the storage object associated.

[JsonPropertyName("file")]
public abstract StorageObjectMetadata File { get; set; }

Property Value

StorageObjectMetadata

Id

Gets the unique (user-defined) ID of the file.

[JsonPropertyName("id")]
public string Id { get; init; }

Property Value

string

IsMoveCompleted

[JsonIgnore]
public virtual bool IsMoveCompleted { get; }

Property Value

bool

IsUploadFailed

[JsonIgnore]
public virtual bool IsUploadFailed { get; }

Property Value

bool

IsUploaded

[JsonIgnore]
public virtual bool IsUploaded { get; }

Property Value

bool

PayloadId

Gets or sets the PayloadId associated with this file.

[JsonPropertyName("payloadId")]
public string? PayloadId { get; set; }

Property Value

string

TaskId

Gets or sets the task ID for the workflow manager to resume a workflow.

[JsonPropertyName("taskId")]
public string? TaskId { get; set; }

Property Value

string

WorkflowInstanceId

Gets or sets the workflow instance ID for the workflow manager to resume a workflow.

[JsonPropertyName("WorkflowInstanceId")]
public string? WorkflowInstanceId { get; set; }

Property Value

string

Workflows

Gets a list of workflows designated for the file.

[JsonPropertyName("workflows")]
[JsonInclude]
public List<string> Workflows { get; }

Property Value

List<string>

Methods

ChangeCorrelationId(ILogger, string)

public void ChangeCorrelationId(ILogger logger, string correlationId)

Parameters

logger ILogger

correlationId string

IpAddress()

public static string IpAddress()

Returns

string

SetFailed()

public virtual void SetFailed()

SetWorkflows(params string[])

Workflows to be launched on MONAI Workflow Manager, ignoring data routing agent.

public void SetWorkflows(params string[] workflows)

Parameters

workflows string[]

List of workflows.