Class FileStorageMetadata

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

Inheritance

System.Object

FileStorageMetadata

DicomFileStorageMetadata

FhirFileStorageMetadata

Hl7FileStorageMetadata

Implements

System.IEquatable<FileStorageMetadata>

Namespace: Monai.Deploy.InformaticsGateway.Api.Storage

Assembly: Monai.Deploy.InformaticsGateway.Api.dll

Syntax

public abstract class FileStorageMetadata : IEquatable<FileStorageMetadata>

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

Declaration

[JsonConstructor]
protected FileStorageMetadata()

FileStorageMetadata(String, String)

Declaration

protected FileStorageMetadata(string correlationId, string identifier)

Parameters

Type	Name	Description
System.String	correlationId
System.String	identifier

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.

Declaration

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

Property Value

Type	Description
System.String

DataOrigin

Gets or sets the data origin of this file.

Declaration

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

Property Value

Type	Description
Monai.Deploy.Messaging.Events.DataOrigin

DataTypeDirectoryName

Gets the root directory name

Declaration

public abstract string DataTypeDirectoryName { get; }

Property Value

Type	Description
System.String

DateReceived

Gets or sets the DateTime that the file was received.

Declaration

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

Property Value

Type	Description
System.DateTime

File

Gets the storage object associated.

Declaration

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

Property Value

Type	Description
StorageObjectMetadata

Id

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

Declaration

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

Property Value

Type	Description
System.String

IsMoveCompleted

Declaration

[JsonIgnore]
public virtual bool IsMoveCompleted { get; }

Property Value

Type	Description
System.Boolean

IsUploaded

Declaration

[JsonIgnore]
public virtual bool IsUploaded { get; }

Property Value

Type	Description
System.Boolean

IsUploadFailed

Declaration

[JsonIgnore]
public virtual bool IsUploadFailed { get; }

Property Value

Type	Description
System.Boolean

PayloadId

Gets or sets the PayloadId associated with this file.

Declaration

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

Property Value

Type	Description
System.String

TaskId

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

Declaration

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

Property Value

Type	Description
System.String

WorkflowInstanceId

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

Declaration

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

Property Value

Type	Description
System.String

Workflows

Gets a list of workflows designated for the file.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Methods

ChangeCorrelationId(ILogger, String)

Declaration

public void ChangeCorrelationId(ILogger logger, string correlationId)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger	logger
System.String	correlationId

IpAddress()

Declaration

public static string IpAddress()

Returns

Type	Description
System.String

SetFailed()

Declaration

public virtual void SetFailed()

SetWorkflows(String[])

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

Declaration

public void SetWorkflows(params string[] workflows)

Parameters

Type	Name	Description
System.String[]	workflows	List of workflows.

Implements

System.IEquatable<T>