SearchIndexClient Class

Reference

Definition

Namespace:: Microsoft.Azure.Search

Assembly:: Microsoft.Azure.Search.Data.dll

Package:: Microsoft.Azure.Search.Data v10.1.0

Source:: SearchIndexClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Client that can be used to query an index and upload, merge, or delete documents.

public class SearchIndexClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.Search.SearchIndexClient>, IDisposable, Microsoft.Azure.Search.ISearchIndexClient, Microsoft.Rest.Azure.IAzureClient

type SearchIndexClient = class
    inherit ServiceClient<SearchIndexClient>
    interface ISearchIndexClient
    interface IDisposable
    interface IAzureClient

Public Class SearchIndexClient
Inherits ServiceClient(Of SearchIndexClient)
Implements IAzureClient, IDisposable, ISearchIndexClient

Inheritance: Object

ServiceClient<SearchIndexClient>
SearchIndexClient

Implements: ISearchIndexClient IAzureClient IDisposable

Constructors

SearchIndexClient(DelegatingHandler[])	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(HttpClient, Boolean)	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(ServiceClientCredentials, HttpClient, Boolean)	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(String, String, SearchCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(String, String, SearchCredentials)	Initializes a new instance of the SearchIndexClient class.

Properties

AcceptLanguage	The preferred language for the response.
ApiVersion	Client Api Version.
Credentials	Credentials needed for the client to connect to Azure.
DeserializationSettings	Gets or sets json deserialization settings.
Documents	Gets the IDocumentsOperations.
FirstMessageHandler	(Inherited from ServiceClient<T>)
GenerateClientRequestId	Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
HttpClient	(Inherited from ServiceClient<T>)
HttpClientHandler	(Inherited from ServiceClient<T>)
HttpMessageHandlers	(Inherited from ServiceClient<T>)
IndexName	The name of the index.
LongRunningOperationRetryTimeout	The retry timeout in seconds for Long Running Operations. Default value is 30.
SearchCredentials	Gets the credentials used to authenticate to a search service. This can be either a query API key or an admin API key.
SearchDnsSuffix	The DNS suffix of the search service. The default is search.windows.net.
SearchServiceName	The name of the search service.
SerializationSettings	Gets or sets json serialization settings.
UseHttpGetForQueries	Indicates whether the index client should use HTTP GET for making Search, Suggest, and Autocomplete requests to the Azure Cognitive Search REST API. The default is `false`, which indicates that HTTP POST will be used.
UserAgent	(Inherited from ServiceClient<T>)

Methods

CreateHttpHandlerPipeline(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
Dispose()	(Inherited from ServiceClient<T>)
Dispose(Boolean)	(Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClient, HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
SetRetryPolicy(RetryPolicy)	(Inherited from ServiceClient<T>)
SetUserAgent(String, String)	(Inherited from ServiceClient<T>)
SetUserAgent(String)	(Inherited from ServiceClient<T>)
TargetDifferentIndex(String)	Obsolete. Changes the BaseUri of this client to target a different index in the same Azure Cognitive Search service. This method is NOT thread-safe; You must guarantee that no other threads are using the client before calling it.

Applies to

Dela via