SearchIndexerClient.CreateOrUpdateIndexerAsync Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.7.0-beta.1

Source:

SearchIndexerClient.cs

Creates a new indexer or updates an existing indexer.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer>> CreateOrUpdateIndexerAsync (Azure.Search.Documents.Indexes.Models.SearchIndexer indexer, bool onlyIfUnchanged = false, bool? ignoreCacheResetRequirements = default, bool? disableCacheReprocessingChangeDetection = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateIndexerAsync : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer>>
override this.CreateOrUpdateIndexerAsync : Azure.Search.Documents.Indexes.Models.SearchIndexer * bool * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer>>

Public Overridable Function CreateOrUpdateIndexerAsync (indexer As SearchIndexer, Optional onlyIfUnchanged As Boolean = false, Optional ignoreCacheResetRequirements As Nullable(Of Boolean) = Nothing, Optional disableCacheReprocessingChangeDetection As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexer))

Parameters

indexer

SearchIndexer

Required. The SearchIndexer to create or update.

onlyIfUnchanged

Boolean

True to throw a RequestFailedException if the ETag does not match the current service version; otherwise, the current service version will be overwritten.

disableCacheReprocessingChangeDetectionignoreCacheResetRequirements

Nullable<Boolean>

Disables cache reprocessing change detection.

ignoreCacheResetRequirementsdisableCacheReprocessingChangeDetection

Nullable<Boolean>

Ignores cache reset requirements.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Task<Response<SearchIndexer>>

The Response<T> from the server containing the SearchIndexer created. This may differ slightly from what was passed into the service.

Exceptions

ArgumentNullException

Thrown when indexer is null.

RequestFailedException

Thrown when a failure is returned by the Search service.