SearchModelFactory.KnowledgeBaseActivityStartedEvent Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.2

Source:

SearchModelFactory.cs

Emitted immediately before an individual retrieval activity begins executing.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityStartedEvent KnowledgeBaseActivityStartedEvent(int id = 0, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecordType type = default, DateTimeOffset startedOn = default, string knowledgeSourceName = default);

static member KnowledgeBaseActivityStartedEvent : int * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecordType * DateTimeOffset * string -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityStartedEvent

Public Shared Function KnowledgeBaseActivityStartedEvent (Optional id As Integer = 0, Optional type As KnowledgeBaseActivityRecordType = Nothing, Optional startedOn As DateTimeOffset = Nothing, Optional knowledgeSourceName As String = Nothing) As KnowledgeBaseActivityStartedEvent

Parameters

id

Int32

The ID of the activity record, matching the id on the corresponding activity.completed event.

type

KnowledgeBaseActivityRecordType

The type of the activity that has started.

startedOn

DateTimeOffset

The time at which the activity started.

knowledgeSourceName

String

The knowledge source used by the activity, when the activity targets a knowledge source.

Returns

KnowledgeBaseActivityStartedEvent

A new KnowledgeBaseActivityStartedEvent instance for mocking.