Class FileStorageMetadata

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

Inheritance

Object

FileStorageMetadata

DicomFileStorageMetadata

FhirFileStorageMetadata

Hl7FileStorageMetadata

Implements

IEquatable<FileStorageMetadata>

Namespace: Monai.Deploy.InformaticsGateway.Api.Storage

Assembly: Monai.Deploy.InformaticsGateway.Api.dll

Syntax

public abstract class FileStorageMetadata : IEquatable<FileStorageMetadata>

Constructors

| Improve this Doc View Source

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()

| Improve this Doc View Source

FileStorageMetadata(String, String)

Declaration

protected FileStorageMetadata(string correlationId, string identifier)

Parameters

Type	Name	Description
String	correlationId
String	identifier

Properties

| Improve this Doc View Source

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
String

| Improve this Doc View Source

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

| Improve this Doc View Source

DataTypeDirectoryName

Gets the root directory name

Declaration

public abstract string DataTypeDirectoryName { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

DateReceived

Gets or sets the DateTime that the file was received.

Declaration

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

Property Value

Type	Description
DateTime

| Improve this Doc View Source

File

Gets the storage object associated.

Declaration

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

Property Value

Type	Description
StorageObjectMetadata

| Improve this Doc View Source

Id

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

Declaration

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

Property Value

Type	Description
String

| Improve this Doc View Source

IsMoveCompleted

Declaration

[JsonIgnore]
public virtual bool IsMoveCompleted { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

IsUploaded

Declaration

[JsonIgnore]
public virtual bool IsUploaded { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

IsUploadFailed

Declaration

[JsonIgnore]
public virtual bool IsUploadFailed { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

PayloadId

Gets or sets the PayloadId associated with this file.

Declaration

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

Property Value

Type	Description
String

| Improve this Doc View Source

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
String

| Improve this Doc View Source

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
String

| Improve this Doc View Source

Workflows

Gets a list of workflows designated for the file.

Declaration

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

Property Value

Type	Description
List<String>

Methods

| Improve this Doc View Source

ChangeCorrelationId(ILogger, String)

Declaration

public void ChangeCorrelationId(ILogger logger, string correlationId)

Parameters

Type	Name	Description
ILogger	logger
String	correlationId

| Improve this Doc View Source

IpAddress()

Declaration

public static string IpAddress()

Returns

Type	Description
String

| Improve this Doc View Source

SetFailed()

Declaration

public virtual void SetFailed()

| Improve this Doc View Source

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
String[]	workflows	List of workflows.

Implements

System.IEquatable<T>