Class RunMetadata

The metadata for a routine run.

Namespace: Workspace.XBR.Xperiflow.Routines.Runs

Assembly: Xperiflow.dll

Declaration

public class RunMetadata

Properties

InstanceIdentifier

The unique identifier for the RoutineInstance that this run belongs to.

Declaration

public string InstanceIdentifier { get; set; }

RunIdentifier

The unique identifier for the run.

Declaration

public string RunIdentifier { get; set; }

ExecutionIdentifier

The unique identifier for the execution. See Workspace.XBR.Xperiflow.Routines.Runs.ExecutionMetadata.ExecutionIdentifier. for more information.

Declaration

public string ExecutionIdentifier { get; set; }

ExecutionType

The type of execution. See Workspace.XBR.Xperiflow.Routines.Runs.ExecutionMetadata.ExecutionType for more information.

Declaration

public string ExecutionType { get; set; }

MethodName

The name of the method that was invoked for this run.

Declaration

public string MethodName { get; set; }

RoutineCallableType

The type of the callable that was invoked for this run. This will typically be "constructor" or "method".

Declaration

public RoutineCallableType RoutineCallableType { get; set; }

RunName

The user-defined name of the run.

Declaration

public string RunName { get; set; }

RunDescription

The user-defined description of the run.

Declaration

public string RunDescription { get; set; }

CreationTime

The UTC time the run was created.

Declaration

public DateTime CreationTime { get; set; }

ModifiedTime

The UTC time the run was last modified.

Declaration

public DateTime ModifiedTime { get; set; }

CreatedByUserId

The unique identifier of the user that created the run. This will correspond to the OneStream user ID.

Declaration

public string CreatedByUserId { get; set; }

CreatedByUserName

The name of the user that created the run.

Declaration

public string CreatedByUserName { get; set; }

ModifiedByUserId

The unique identifier of the user that last modified the run. This will correspond to the OneStream user ID.

Declaration

public string ModifiedByUserId { get; set; }

ModifiedByUserName

The name of the user that last modified the run.

Declaration

public string ModifiedByUserName { get; set; }

ArtifactPath

The file path to the artifacts for this run.

Declaration

public string ArtifactPath { get; set; }

InputParams

The input parameters that were used to invoke the method for this run.

Declaration

public JObject InputParams { get; set; }

InvocationMethod

The invocation method that was used to invoke the method for this run.

Declaration

public InvocationMethod InvocationMethod { get; set; }

MemoryCapacity

The max memory capacity that this run was/is allowed to use.

Declaration

public double MemoryCapacity { get; set; }

IncludeStatistics

Whether or not Artifact Statistics data should be included in the run. If false, no Artifact Statistics data will be generated and stored in the datastore.

Declaration

public bool IncludeStatistics { get; set; }

IncludePreviews

Whether or not Artifact Preview data should be included in the run. If false, no Artifact Preview data will be generated and stored in the datastore.

Declaration

public bool IncludePreviews { get; set; }

StoreArtifacts

Whether or not the Artifacts are stored in the datastore. If false, this means that the artifacts may be inaccessible and lost. The most common case to set this to false is when the artifacts are not needed after the run is complete or when the artifact are expected to be returned via "in-memory" Run Method execution.

Declaration

public bool StoreArtifacts { get; set; }

Labels

A list of arbitrary labels that are associated with the run. These are often user-defined labels to promote categorization of routines and runs.

Declaration

public IEnumerable<string> Labels { get; set; }

Attributes

Additional attributes that are associated with the run. This is typically used to store additional metadata that is not part of the standard run metadata.

Declaration

public JObject? Attributes { get; set; }

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