Class ArtifactMetadataLookupClient

Namespace: Workspace.XBR.Xperiflow.Routines.Artifacts

Assembly: Xperiflow.dll

Declaration

public class ArtifactMetadataLookupClient : IArtifactMetadataLookupClient

Implements: Workspace.XBR.Xperiflow.Routines.Artifacts.IArtifactMetadataLookupClient

Methods

GetByInstanceIdentifierAsync(string, CancellationToken)

Retrieves all artifact metadata associated with the specified routine instance.

Declaration

public Task<List<ArtifactMetadata>> GetByInstanceIdentifierAsync(string instanceIdentifier, CancellationToken cancellationToken = default)

Remarks

This method retrieves metadata for all artifacts that have been created by any run of the specified routine instance. The results include artifacts from all runs, both completed and in-progress.

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata}>

A task that represents the asynchronous operation. The task result contains a list of Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata objects for all artifacts associated with the specified instance.

Parameters

Type	Name	Description
System.String	instanceIdentifier	The unique identifier of the routine instance
System.Threading.CancellationToken	cancellationToken	Token to monitor for cancellation requests

Exceptions

System.ArgumentException Thrown when instanceIdentifier is null or empty Workspace.XBR.Xperiflow.Routines.RoutineClientException Thrown when an error occurs during artifact metadata retrieval

GetByRunIdentifierAsync(string, string, CancellationToken)

Retrieves all artifact metadata for the specified routine run.

Declaration

public Task<List<ArtifactMetadata>> GetByRunIdentifierAsync(string instanceIdentifier, string runIdentifier, CancellationToken cancellationToken = default)

Remarks

This method retrieves metadata for all artifacts that were created during the specified routine run. This provides a focused view of artifacts from a single execution context.

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata}>

A task that represents the asynchronous operation. The task result contains a list of Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata objects for all artifacts created by the specified run.

Parameters

Type	Name	Description
System.String	instanceIdentifier	The unique identifier of the routine instance
System.String	runIdentifier	The unique identifier of the routine run
System.Threading.CancellationToken	cancellationToken	Token to monitor for cancellation requests

Exceptions

System.ArgumentException Thrown when instanceIdentifier or runIdentifier is null or empty Workspace.XBR.Xperiflow.Routines.RoutineClientException Thrown when an error occurs during artifact metadata retrieval

GetByPathAsync(string, CancellationToken)

Retrieves artifact metadata for the artifact at the specified storage path.

Declaration

public Task<ArtifactMetadata?> GetByPathAsync(string artifactPath, CancellationToken cancellationToken = default)

Remarks

This method enables path-based artifact discovery, which is useful when working with artifacts through file system operations or when the artifact path is known but the routine context is not.

Returns

Task< Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata >

A task that represents the asynchronous operation. The task result contains the Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata if found, or null if no artifact exists at the specified path.

Parameters

Type	Name	Description
System.String	artifactPath	The storage path of the artifact
System.Threading.CancellationToken	cancellationToken	Token to monitor for cancellation requests

Exceptions

System.ArgumentException Thrown when artifactPath is null or empty Workspace.XBR.Xperiflow.Routines.RoutineClientException Thrown when an error occurs during artifact metadata retrieval

GetByQualifiedKeyAsync(string, string, string, CancellationToken)

Retrieves artifact metadata for the artifact with the specified qualified key within a routine run.

Declaration

public Task<ArtifactMetadata?> GetByQualifiedKeyAsync(string instanceIdentifier, string runIdentifier, string qualifiedKey, CancellationToken cancellationToken = default)

Remarks

This method provides the most specific artifact lookup mechanism, allowing retrieval of individual artifacts by their qualified key within a specific run context. The qualified key is a dot-delimited path that uniquely identifies the artifact within the run's output structure.

Returns

Task< Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata >

A task that represents the asynchronous operation. The task result contains the Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactMetadata if found, or null if no artifact with the specified qualified key exists in the run.

Parameters

Type	Name	Description
System.String	instanceIdentifier	The unique identifier of the routine instance
System.String	runIdentifier	The unique identifier of the routine run
System.String	qualifiedKey	The qualified key of the artifact (e.g., "output.dataframe", "results.metrics")
System.Threading.CancellationToken	cancellationToken	Token to monitor for cancellation requests

Exceptions

System.ArgumentException Thrown when any parameter is null or empty Workspace.XBR.Xperiflow.Routines.RoutineClientException Thrown when an error occurs during artifact metadata retrieval

Implements

• Workspace.XBR.Xperiflow.Routines.Artifacts.IArtifactMetadataLookupClient

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString