Class RunMetadataInfoLookupClient

An object that manages the lookup of Run Metadata for Xperiflow Routines.

Namespace: Workspace.XBR.Xperiflow.Routines.Runs

Assembly: Xperiflow.dll

Declaration

public class RunMetadataInfoLookupClient : IRunMetadataInfoLookupClient

Implements: Workspace.XBR.Xperiflow.Routines.Runs.IRunMetadataInfoLookupClient

Methods

GetByInstanceIdentifierAsync(string, CancellationToken)

Retrieves a list of RunMetadata objects by Routine Instance Id. If there is no Routine Instance with the given Id, an empty list is returned.

Declaration

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

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo}>

A list of RunMetadata objects.

Parameters

Type	Name	Description
System.String	instanceIdentifier	The Routine Instance Id to filter by. Note that this is case-sensitive.
System.Threading.CancellationToken	cancellationToken

GetByInstanceIdAndMethodNameAsync(string, string, CancellationToken)

Retrieves a list of RunMetadata objects by Routine Instance Id and Method Name. If there is no Routine Instance with the given Id and Method Name, an empty list is returned.

Declaration

public Task<List<RunMetadataInfo>> GetByInstanceIdAndMethodNameAsync(string instanceIdentifier, string methodName, CancellationToken cancellationToken = default)

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo}>

A list of RunMetadata objects

Parameters

Type	Name	Description
System.String	instanceIdentifier	The Routine Instance Id to filter by. Note that this is case-sensitive.
System.String	methodName	The Routine Method name to filter by.
System.Threading.CancellationToken	cancellationToken

GetByInstanceNameAsync(string, CancellationToken)

Get a list of RunMetadata objects by the Routine Instance Name. If there is no Routine Instance with the given Name, an empty list is returned.

Declaration

public Task<List<RunMetadataInfo>> GetByInstanceNameAsync(string instanceName, CancellationToken cancellationToken = default)

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo}>

A list of RunMetadata objects

Parameters

Type	Name	Description
System.String	instanceName	The Routine Instance Name to filter by.
System.Threading.CancellationToken	cancellationToken

GetByRunIdentifierAsync(string, string, CancellationToken)

Retrieves a RunMetadata object by the Routine Run Id. If there is no Run with the given Id, null is returned.

Declaration

public Task<RunMetadataInfo?> GetByRunIdentifierAsync(string instanceIdentifier, string runIdentifier, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

A RunMetadata object. null is returned in if there is not matching Run

Parameters

Type	Name
System.String	instanceIdentifier
System.String	runIdentifier
System.Threading.CancellationToken	cancellationToken

GetByRunNameAsync(string, string, CancellationToken)

Retrieves a RunMetadata object by the Routine Run Name. If there is no Run with the given runName, null is returned;

Declaration

public Task<RunMetadataInfo?> GetByRunNameAsync(string instanceIdentifier, string runName, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

Parameters

Type	Name	Description
System.String	instanceIdentifier	The Routine Instance Id to filter by.
System.String	runName	The Routine Run name to retrieve.
System.Threading.CancellationToken	cancellationToken

GetByInstanceIdentifierAndCallableTypeAsync(string, RoutineCallableType, CancellationToken)

Declaration

public Task<List<RunMetadataInfo>> GetByInstanceIdentifierAndCallableTypeAsync(string instanceIdentifier, RoutineCallableType routineCallableType, CancellationToken cancellationToken = default)

Returns

Task<System.Collections.Generic.List{Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo}>

Parameters

Type	Name
System.String	instanceIdentifier
Workspace.XBR.Xperiflow.Routines.RoutineCallableType	routineCallableType
System.Threading.CancellationToken	cancellationToken

GetLatestByInstanceIdentifierAsync(string, CancellationToken)

Retrieves a the latest RunMetadata object by Run's StartTime and the Routine Instance Id. If there is no Run with the given Id, null is returned.

Declaration

public Task<RunMetadataInfo?> GetLatestByInstanceIdentifierAsync(string instanceIdentifier, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

A RunMetadata object. null is returned in if there is not matching Run

Parameters

Type	Name	Description
System.String	instanceIdentifier	The Routine Instance Id to filter by. Note that this is case-sensitive.
System.Threading.CancellationToken	cancellationToken

GetLatestByInstanceNameAsync(string, CancellationToken)

Retrieves a the latest RunMetadata object by Run's StartTime and the Routine Instance Name. If there is no Run with the given Id, null is returned.

Declaration

public Task<RunMetadataInfo?> GetLatestByInstanceNameAsync(string instanceName, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

A RunMetadata object. null is returned in if there is not matching Run

Parameters

Type	Name	Description
System.String	instanceName	The Routine Instance Name to filter by.
System.Threading.CancellationToken	cancellationToken

GetLatestByInstanceIdAndMethodNameAsync(string, string, CancellationToken)

Retrieves a the latest RunMetadata object by Run's StartTime, the Routine Instance Id, and the Method Name. If there is no Run with the given Id, null is returned.

Declaration

public Task<RunMetadataInfo?> GetLatestByInstanceIdAndMethodNameAsync(string instanceIdentifier, string methodName, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

A RunMetadata object. null is returned in if there is not matching Run

Parameters

Type	Name	Description
System.String	instanceIdentifier	The Routine Instance Id to filter by. Note that this is case-sensitive.
System.String	methodName	The Routine Method name to filter by.
System.Threading.CancellationToken	cancellationToken

GetLatestByInstanceNameAndMethodNameAsync(string, string, CancellationToken)

Retrieves a RunMetadata object by the latest Run's StartTime, the Routine Instance Name, and the Method Name. If there is no Run with the given Id, null is returned.

Declaration

public Task<RunMetadataInfo?> GetLatestByInstanceNameAndMethodNameAsync(string instanceName, string methodName, CancellationToken cancellationToken = default)

Returns

Task< Workspace.XBR.Xperiflow.Routines.Runs.RunMetadataInfo >

A RunMetadata object. null is returned in if there is not matching Run

Parameters

Type	Name	Description
System.String	instanceName	The Routine Instance Name to filter by.
System.String	methodName	The Routine Method name to filter by.
System.Threading.CancellationToken	cancellationToken

Implements

• Workspace.XBR.Xperiflow.Routines.Runs.IRunMetadataInfoLookupClient

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