ExecutionHistoryEntry Class

Definition

Namespace:
Azure.AI.Discovery
Assembly:
Azure.AI.Discovery.dll
Package:
Azure.AI.Discovery v1.0.0-beta.1
Source:
ExecutionHistoryEntry.cs

Execution history entry for a task.

public class ExecutionHistoryEntry : System.ClientModel.Primitives.IJsonModel<Azure.AI.Discovery.ExecutionHistoryEntry>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Discovery.ExecutionHistoryEntry>
type ExecutionHistoryEntry = class
    interface IJsonModel<ExecutionHistoryEntry>
    interface IPersistableModel<ExecutionHistoryEntry>
Public Class ExecutionHistoryEntry
Implements IJsonModel(Of ExecutionHistoryEntry), IPersistableModel(Of ExecutionHistoryEntry)
Inheritance
Object
ExecutionHistoryEntry
Implements
IJsonModel<ExecutionHistoryEntry> IPersistableModel<ExecutionHistoryEntry> IPersistableModel<T>

Constructors

Name Description
ExecutionHistoryEntry(DateTimeOffset, String, String, DiscoveryActorType)

Initializes a new instance of ExecutionHistoryEntry.

Properties

Name Description
Action

The action that was performed (controlled vocabulary; semi-open).
AdditionalDetails

Freeform key-value pairs for additional details.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

CreatedAt

Timestamp when the entry was created (ISO 8601 UTC format).
CreatedBy

Identifier of who created this entry (GUID for user | resourceId for application | arbitrary string for other types).
CreatedByType

Type of entity that created this entry (User, Application, System, or custom type).
ResponseMessageId

Run or message ID for full details.
ResponseMessageText

Detailed completion message.
Summary

Brief summary of the execution event.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Implicit(ExecutionHistoryEntry to RequestContent)

Explicit Interface Implementations

Name Description
IJsonModel<ExecutionHistoryEntry>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ExecutionHistoryEntry>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ExecutionHistoryEntry>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ExecutionHistoryEntry>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ExecutionHistoryEntry>.Write(ModelReaderWriterOptions)

Applies to