IIndexesOperations.ExistsWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Search

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Determines whether or not the given index exists in the search service.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<bool>> ExistsWithHttpMessagesAsync (string indexName, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ExistsWithHttpMessagesAsync : string * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<bool>>

Public Function ExistsWithHttpMessagesAsync (indexName As String, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Boolean))

Parameters

indexName

String

The name of the index.

searchRequestOptions

SearchRequestOptions

Additional parameters for the operation.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<Boolean>>

A response with the value true if the index exists; false otherwise.

Exceptions

CloudException

Thrown when the operation returned an invalid status code.

SerializationException

Thrown when unable to deserialize the response.

ValidationException

Thrown when a required parameter is null.

ArgumentNullException

Thrown when a required parameter is null.