Microsoft.Azure.Search.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Azure.Search</name> </assembly> <members> <member name="T:Microsoft.Rest.Azure.CloudExceptionExtensions"> <summary> Defines extension methods for the CloudException class. </summary> </member> <member name="M:Microsoft.Rest.Azure.CloudExceptionExtensions.IsAccessConditionFailed(Microsoft.Rest.Azure.CloudException)"> <summary> Indicates whether the exception is the result of a failed access condition (ETag) check. </summary> <param name="exception">The exception to check.</param> <returns>true if the exception is a failed access condition (HTTP 412 Precondition Failed), false otherwise.</returns> </member> <member name="T:Microsoft.Azure.Search.IndexBatchException"> <summary> Exception thrown when an indexing operation only partially succeeds. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexBatchException.#ctor(Microsoft.Azure.Search.Models.DocumentIndexResult)"> <summary> Initializes a new instance of the IndexBatchException class. </summary> <param name="documentIndexResult">The deserialized response from the index request.</param> </member> <member name="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults"> <summary> Gets the results for the index batch that contains the status for each individual index action. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexBatchException.FindFailedActionsToRetry(Microsoft.Azure.Search.Models.IndexBatch,System.String)"> <summary> Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch. </summary> <param name="originalBatch">The batch that partially failed indexing.</param> <param name="keyFieldName">The name of the key field from the index schema.</param> <returns> A new batch containing all the actions from the given batch that failed and should be retried. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexBatchException.FindFailedActionsToRetry``1(Microsoft.Azure.Search.Models.IndexBatch{``0},System.Func{``0,System.String})"> <summary> Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="originalBatch">The batch that partially failed indexing.</param> <param name="keySelector">A lambda that retrieves a key value from a given document of type T.</param> <returns> A new batch containing all the actions from the given batch that failed and should be retried. </returns> </member> <member name="T:Microsoft.Azure.Search.ISearchIndexClient"> <summary> Client that can be used to query an Azure Search index and upload, merge, or delete documents. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.SearchCredentials"> <summary> Gets the credentials used to authenticate to an Azure Search service. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.UseHttpGetForQueries"> <summary> Indicates whether the index client should use HTTP GET for making Search and Suggest requests to the Azure Search REST API. The default is <c>false</c>, which indicates that HTTP POST will be used. </summary> </member> <member name="M:Microsoft.Azure.Search.ISearchIndexClient.TargetDifferentIndex(System.String)"> <summary> Changes the BaseUri of this client to target a different index in the same Azure Search service. This method is NOT thread-safe; You must guarantee that no other threads are using the client before calling it. </summary> <param name="newIndexName">The name of the index to which all subsequent requests should be sent.</param> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.ApiVersion"> <summary> Client Api Version. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchIndexClient.Documents"> <summary> Gets the IDocumentsOperations. </summary> </member> <member name="T:Microsoft.Azure.Search.ISearchServiceClient"> <summary> Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.SearchCredentials"> <summary> Gets the credentials used to authenticate to an Azure Search service. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.ApiVersion"> <summary> Client Api Version. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.DataSources"> <summary> Gets the IDataSourcesOperations. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.Indexers"> <summary> Gets the IIndexersOperations. </summary> </member> <member name="P:Microsoft.Azure.Search.ISearchServiceClient.Indexes"> <summary> Gets the IIndexesOperations. </summary> </member> <member name="T:Microsoft.Azure.Search.SearchCredentials"> <summary> Credentials used to authenticate to an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/"/> </summary> </member> <member name="M:Microsoft.Azure.Search.SearchCredentials.#ctor(System.String)"> <summary> Initializes a new instance of the SearchCredentials class with a query key or an admin key. Use a query key if your application does not require write access to the Search Service or index. </summary> <param name="apiKey">api-key used to authenticate to the Azure Search service.</param> <remarks> If your application performs only query operations on an index, we recommend passing a query key for the <paramref name="apiKey"/> parameter. This ensures that you have read-only access to the index, which is consistent with the principle of least privilege. </remarks> </member> <member name="P:Microsoft.Azure.Search.SearchCredentials.ApiKey"> <summary> api-key used to authenticate to an Azure Search service. Can be either a query key for querying only, or an admin key that enables index and document management as well. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchCredentials.ProcessHttpRequestAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)"> <summary> Adds the credentials to the given HTTP request. </summary> <param name="request">HTTP request</param> <param name="cancellationToken">Cancellation token</param> <returns>A Task to track the progress of the async operation.</returns> </member> <member name="T:Microsoft.Azure.Search.SearchIndexClient"> <summary> Client that can be used to query an Azure Search index and upload, merge, or delete documents. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.String,System.String,Microsoft.Azure.Search.SearchCredentials)"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='searchServiceName'>Required. The name of the Azure Search service.</param> <param name='indexName'>Required. The name of the Azure Search index.</param> <param name='credentials'>Required. The credentials used to authenticate to an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/" /> </param> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.String,System.String,Microsoft.Azure.Search.SearchCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='searchServiceName'>Required. The name of the Azure Search service.</param> <param name='indexName'>Required. The name of the Azure Search index.</param> <param name='credentials'>Required. The credentials used to authenticate to an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/" /> </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The set of delegating handlers to insert in the http client pipeline. </param> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.SearchCredentials"> <inheritdoc /> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.UseHttpGetForQueries"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.TargetDifferentIndex(System.String)"> <inheritdoc /> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.ApiVersion"> <summary> Client Api Version. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchIndexClient.Documents"> <summary> Gets the IDocumentsOperations. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Uri,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Uri,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchIndexClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchIndexClient.Initialize"> <summary> Initializes client properties. </summary> </member> <member name="T:Microsoft.Azure.Search.SearchServiceClient"> <summary> Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.String,Microsoft.Azure.Search.SearchCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='searchServiceName'>Required. The name of the Azure Search service.</param> <param name='credentials'>Required. The credentials used to authenticate to an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/" /> </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The set of delegating handlers to insert in the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.String,Microsoft.Azure.Search.SearchCredentials)"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='searchServiceName'>Required. The name of the Azure Search service.</param> <param name='credentials'>Required. The credentials used to authenticate to an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/" /> </param> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.SearchCredentials"> <inheritdoc /> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.ApiVersion"> <summary> Client Api Version. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.DataSources"> <summary> Gets the IDataSourcesOperations. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.Indexers"> <summary> Gets the IIndexersOperations. </summary> </member> <member name="P:Microsoft.Azure.Search.SearchServiceClient.Indexes"> <summary> Gets the IIndexesOperations. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Uri,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Uri,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the SearchServiceClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.SearchServiceClient.Initialize"> <summary> Initializes client properties. </summary> </member> <member name="T:Microsoft.Azure.Search.DataSourcesOperations"> <summary> DataSourcesOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.#ctor(Microsoft.Azure.Search.SearchServiceClient)"> <summary> Initializes a new instance of the DataSourcesOperations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Search.DataSourcesOperations.Client"> <summary> Gets a reference to the SearchServiceClient </summary> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to create or update. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves a datasource definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.ListWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all datasources available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" /> </summary> <param name='dataSource'> The definition of the datasource to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Search.DataSourcesOperationsExtensions"> <summary> Operations for managing datasources. <see href="https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" /> </summary> <summary> Extension methods for DataSourcesOperations. </summary> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.Exists(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Determines whether or not the given data source exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="dataSourceName"> The name of the data source. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> <c>true</c> if the data source exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.ExistsAsync(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Determines whether or not the given data source exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="dataSourceName"> The name of the data source. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> <c>true</c> if the data source exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to create or update. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to create or update. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.Delete(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Deletes an Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.DeleteAsync(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Deletes an Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.Get(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves a datasource definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.GetAsync(Microsoft.Azure.Search.IDataSourcesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves a datasource definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSourceName'> The name of the datasource to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.List(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Lists all datasources available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.ListAsync(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Lists all datasources available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.Create(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Creates a new Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSource'> The definition of the datasource to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DataSourcesOperationsExtensions.CreateAsync(Microsoft.Azure.Search.IDataSourcesOperations,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='dataSource'> The definition of the datasource to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="T:Microsoft.Azure.Search.IDataSourcesOperations"> <summary> DataSourcesOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. </summary> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Determines whether or not the given data source exists in the Azure Search service. </summary> <param name="dataSourceName"> The name of the data source. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> A response with the value <c>true</c> if the data source exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource or updates a datasource if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to create or update. </param> <param name='dataSource'> The definition of the datasource to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves a datasource definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" /> </summary> <param name='dataSourceName'> The name of the datasource to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.ListWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all datasources available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IDataSourcesOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.DataSource,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search datasource. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" /> </summary> <param name='dataSource'> The definition of the datasource to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DataSource"> <summary> Represents a datasource definition in Azure Search, which can be used to configure an indexer. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.AzureSql(System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to an Azure SQL database. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the Azure SQL database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="deletionDetectionPolicy">Optional. The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.AzureSql(System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataChangeDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to an Azure SQL database with change detection enabled. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the Azure SQL database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="changeDetectionPolicy">The change detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.AzureSql(System.String,System.String,System.String,Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to an Azure SQL database with change detection and deletion detection enabled. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the Azure SQL database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="changeDetectionPolicy">The change detection policy for the datasource. Note that only high watermark change detection is allowed for Azure SQL when deletion detection is enabled.</param> <param name="deletionDetectionPolicy">The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.SqlServerOnAzureVM(System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to a VM-hosted SQL Server database. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the SQL Server database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="deletionDetectionPolicy">Optional. The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.SqlServerOnAzureVM(System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataChangeDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to a VM-hosted SQL Server database with change detection enabled. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the SQL Server database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="changeDetectionPolicy">The change detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.SqlServerOnAzureVM(System.String,System.String,System.String,Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to a VM-hosted SQL Server database with change detection and deletion detection enabled. </summary> <param name="name">The name of the datasource.</param> <param name="sqlConnectionString">The connection string for the SQL Server database.</param> <param name="tableOrViewName">The name of the table or view from which to read rows.</param> <param name="changeDetectionPolicy">The change detection policy for the datasource. Note that only high watermark change detection is allowed for SQL Server when deletion detection is enabled.</param> <param name="deletionDetectionPolicy">The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.DocumentDb(System.String,System.String,System.String,System.String,System.Boolean,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to a DocumentDb database. </summary> <param name="name">The name of the datasource.</param> <param name="documentDbConnectionString">The connection string for the DocumentDb database. It must follow this format: "AccountName|AccountEndpoint=[your account name or endpoint];AccountKey=[your account key];Database=[your database name]"</param> <param name="collectionName">The name of the collection from which to read documents.</param> <param name="query">Optional. A query that is applied to the collection when reading documents.</param> <param name="useChangeDetection">Optional. Indicates whether to use change detection when indexing. Default is true.</param> <param name="deletionDetectionPolicy">Optional. The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.AzureBlobStorage(System.String,System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to an Azure Blob container. </summary> <param name="name">The name of the datasource.</param> <param name="storageConnectionString">The connection string for the Azure Storage account. It must follow this format: "DefaultEndpointsProtocol=https;AccountName=[your storage account];AccountKey=[your account key];" Note that HTTPS is required.</param> <param name="containerName">The name of the container from which to read blobs.</param> <param name="pathPrefix">Optional. If specified, the datasource will include only blobs with names starting with this prefix. This is useful when blobs are organized into "virtual folders", for example.</param> <param name="deletionDetectionPolicy">Optional. The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.AzureTableStorage(System.String,System.String,System.String,System.String,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Creates a new DataSource to connect to an Azure Table. </summary> <param name="name">The name of the datasource.</param> <param name="storageConnectionString">The connection string for the Azure Storage account. It must follow this format: "DefaultEndpointsProtocol=https;AccountName=[your storage account];AccountKey=[your account key];" Note that HTTPS is required.</param> <param name="tableName">The name of the table from which to read rows.</param> <param name="query">Optional. A query that is applied to the table when reading rows.</param> <param name="deletionDetectionPolicy">Optional. The data deletion detection policy for the datasource.</param> <param name="description">Optional. Description of the datasource.</param> <returns>A new DataSource instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.#ctor"> <summary> Initializes a new instance of the DataSource class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.#ctor(System.String,Microsoft.Azure.Search.Models.DataSourceType,Microsoft.Azure.Search.Models.DataSourceCredentials,Microsoft.Azure.Search.Models.DataContainer,System.String,Microsoft.Azure.Search.Models.DataChangeDetectionPolicy,Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy,System.String)"> <summary> Initializes a new instance of the DataSource class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.Name"> <summary> Gets or sets the name of the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.Description"> <summary> Gets or sets the description of the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.Type"> <summary> Gets or sets the type of the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.Credentials"> <summary> Gets or sets credentials for the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.Container"> <summary> Gets or sets the data container for the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.DataChangeDetectionPolicy"> <summary> Gets or sets the data change detection policy for the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.DataDeletionDetectionPolicy"> <summary> Gets or sets the data deletion detection policy for the datasource. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSource.ETag"> <summary> Gets or sets the ETag of the DataSource. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSource.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DataSourceType"> <summary> Defines the type of an Azure Search datasource. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataSourceType.AzureSql"> <summary> Indicates an Azure SQL datasource. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataSourceType.DocumentDb"> <summary> Indicates a DocumentDB datasource. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataSourceType.AzureBlob"> <summary> Indicates a Azure Blob datasource. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataSourceType.AzureTable"> <summary> Indicates a Azure Table datasource. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceType.Create(System.String)"> <summary> Creates a new DataSourceType instance, or returns an existing instance if the given name matches that of a known data source type. </summary> <param name="name">Name of the data source type.</param> <returns>A DataSourceType instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceType.op_Implicit(System.String)~Microsoft.Azure.Search.Models.DataSourceType"> <summary> Defines implicit conversion from string to DataSourceType. </summary> <param name="name">string to convert.</param> <returns>The string as a DataSourceType.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy"> <summary> Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy.#ctor(System.String,System.Object)"> <summary> Initializes a new instance of the SoftDeleteColumnDeletionDetectionPolicy class with required arguments. </summary> <param name="softDeleteColumnName"> Specifies the name of the column to use for soft-deletion detection. </param> <param name="softDeleteMarkerValue"> Specifies the marker value that indentifies an item as deleted. </param> </member> <member name="M:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy.#ctor"> <summary> Initializes a new instance of the SoftDeleteColumnDeletionDetectionPolicy class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the SoftDeleteColumnDeletionDetectionPolicy class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy.SoftDeleteColumnName"> <summary> Gets or sets the name of the column to use for soft-deletion detection. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SoftDeleteColumnDeletionDetectionPolicy.SoftDeleteMarkerValue"> <summary> Gets or sets the marker value that indentifies an item as deleted. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.Document"> <summary> Represents a document as a property bag. This is useful for scenarios where the index schema is only known at run-time. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Document.#ctor"> <summary> Initializes a new instance of the Document class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSearchResult"> <summary> Response containing search results from an Azure Search index. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2"> <summary> Response containing search results from an Azure Search index. </summary> <typeparam name="TDoc"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <typeparam name="TResult"> Type of the model class that encapsulates documents in a search response. </typeparam> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.Count"> <summary> Gets the total count of results found by the search operation, or null if the count was not requested. </summary> <remarks> If present, the count may be greater than the number of results in this response. This can happen if you use the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> or <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters, or if Azure Search can't return all the requested documents in a single Search response. </remarks> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.Coverage"> <summary> Gets a value indicating the percentage of the index that was included in the query, or null if MinimumCoverage was not set in the <c cref="T:Microsoft.Azure.Search.Models.SearchParameters">SearchParameters</c>. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.Facets"> <summary> Gets the facet query results for the search operation, or null if the query did not include any facet expressions. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.Results"> <summary> Gets the sequence of results returned by the query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken"> <summary> Gets a continuation token that is used to continue fetching search results. This is necessary when Azure Search cannot fulfill a search request with a single response. </summary> <remarks> <para> This property will be null unless Azure Search can't return all the requested documents in a single Search response. That can happen for different reasons which are implementation-specific and subject to change. Robust clients should always be ready to handle cases where fewer documents than expected are returned and a continuation token is included to continue retrieving documents. If this property is not null, you can pass its value to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.ContinueSearchWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">ContinueSearchAsync</c> method to retrieve more search results. </para> <para> Note that this property is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> search parameters. </para> </remarks> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSearchResult`1"> <summary> Response containing search results from an Azure Search index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSuggestResult"> <summary> Response containing suggestion query results from an Azure Search index. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSuggestResultBase`2"> <summary> Response containing suggestion query results from an Azure Search index. </summary> <typeparam name="TDoc"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <typeparam name="TResult"> Type of the model class that encapsulates documents in a suggestion response. </typeparam> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSuggestResultBase`2.Coverage"> <summary> Gets a value indicating the percentage of the index that was included in the query, or null if MinimumCoverage was not set in the <c cref="T:Microsoft.Azure.Search.Models.SuggestParameters">SuggestParameters</c>. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentSuggestResultBase`2.Results"> <summary> Gets the sequence of results returned by the query. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentSuggestResult`1"> <summary> Response containing suggestion query results from an Azure Search index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> </member> <member name="T:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter"> <summary> Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.#ctor"> <summary> Initializes a new instance of the EdgeNGramTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide})"> <summary> Initializes a new instance of the EdgeNGramTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. Must be less than the value of maxGram. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.Side"> <summary> Gets or sets specifies which side of the input the n-gram should be generated from. Default is "front". Possible values include: 'front', 'back' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.FacetResult"> <summary> A single bucket of a facet query result that reports the number of documents with a field falling within a particular range or having a particular value or interval. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FacetResult.#ctor"> <summary> Initializes a new instance of the Facet class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FacetResult.Type"> <summary> Gets a value indicating the type of this facet. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FacetResult.From"> <summary> Gets a value indicating the inclusive lower bound of the facet's range, or null to indicate that there is no lower bound (i.e. -- for the first bucket). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FacetResult.To"> <summary> Gets a value indicating the exclusive upper bound of the facet's range, or null to indicate that there is no upper bound (i.e. -- for the last bucket). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FacetResult.Value"> <summary> Gets the value of the facet, or the inclusive lower bound if it's an interval facet. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FacetResult.Count"> <summary> Gets the approximate count of documents falling within the bucket described by this facet. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FacetResult.AsRangeFacetResult``1"> <summary> Attempts to convert the facet to a range facet of the given type. </summary> <typeparam name="T"> A type that matches the type of the field to which the facet was applied. Valid types include <c cref="T:System.DateTimeOffset">DateTimeOffset</c>, <c cref="T:System.Double">Double</c>, and <c cref="T:System.Int64">Int64</c> (long in C#). </typeparam> <returns>A new strongly-typed range facet instance.</returns> <exception cref="T:System.InvalidCastException">This instance is not a range facet of the given type.</exception> </member> <member name="M:Microsoft.Azure.Search.Models.FacetResult.AsValueFacetResult``1"> <summary> Attempts to convert the facet to a value facet of the given type. </summary> <typeparam name="T"> A type that matches the type of the field to which the facet was applied. </typeparam> <returns>A new strongly-typed value facet instance.</returns> <exception cref="T:System.InvalidCastException">This instance is not a value facet of the given type.</exception> </member> <member name="T:Microsoft.Azure.Search.Models.FacetResults"> <summary> Contains all the results of a facet query, organized as a collection of buckets for each faceted field. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.FacetType"> <summary> Specifies the type of a facet query result. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.FacetType.Value"> <summary> The facet counts documents with a particular field value. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.FacetType.Range"> <summary> The facet counts documents with a field value in a particular range. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.HitHighlights"> <summary> Contains all the hit highlights for a document, organized as a collection of text fragments for each applicable field. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexAction"> <summary> Represents an index action that operates on a document. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Delete(System.String,System.String)"> <summary> Creates a new IndexAction for deleting a document. </summary> <param name="keyName">The name of the key field of the index.</param> <param name="keyValue">The key of the document to delete.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Delete(Microsoft.Azure.Search.Models.Document)"> <summary> Creates a new IndexAction for deleting a document. </summary> <param name="document">The document to delete; Fields other than the key are ignored.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Delete``1(``0)"> <summary> Creates a new IndexAction for deleting a document. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="document">The document to delete; Fields other than the key are ignored.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Merge(Microsoft.Azure.Search.Models.Document)"> <summary> Creates a new IndexAction for merging a document into an existing document in the index. </summary> <param name="document">The document to merge; Set only the fields that you want to change.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Merge``1(``0)"> <summary> Creates a new IndexAction for merging a document into an existing document in the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="document">The document to merge; Set only the properties that you want to change.</param> <returns>A new IndexAction.</returns> <remarks> If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for bool), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare value-typed properties to be nullable in type T. </remarks> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.MergeOrUpload(Microsoft.Azure.Search.Models.Document)"> <summary> Creates a new IndexAction for uploading a document to the index, or merging it into an existing document if it already exists in the index. </summary> <param name="document">The document to merge or upload.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.MergeOrUpload``1(``0)"> <summary> Creates a new IndexAction for uploading a document to the index, or merging it into an existing document if it already exists in the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="document">The document to merge or upload.</param> <returns>A new IndexAction.</returns> <remarks> If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for bool), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare value-typed properties to be nullable in type T. </remarks> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Upload(Microsoft.Azure.Search.Models.Document)"> <summary> Creates a new IndexAction for uploading a document to the index. </summary> <param name="document">The document to upload.</param> <returns>A new IndexAction.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexAction.Upload``1(``0)"> <summary> Creates a new IndexAction for uploading a document to the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="document">The document to upload.</param> <returns>A new IndexAction.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.IndexActionBase`1"> <summary> Abstract base class for index actions that operate on a document. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.IndexActionBase`1.#ctor(Microsoft.Azure.Search.Models.IndexActionType,`0)"> <summary> Initializes a new instance of the IndexActionBase class with the given action type. </summary> <param name="actionType">The type of action to perform on the document.</param> <param name="document">The document on which the action will be performed.</param> </member> <member name="P:Microsoft.Azure.Search.Models.IndexActionBase`1.ActionType"> <summary> Gets a value indicating the action to perform on a document in an indexing batch. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexActionBase`1.Document"> <summary> Gets the document on which the action will be performed; Fields other than the key are ignored for delete actions. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexAction`1"> <summary> Represents an index action that operates on a document. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="T:Microsoft.Azure.Search.Models.IndexBatch"> <summary> Contains a batch of document upload, merge, and/or delete operations to send to the Azure Search index. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.IndexAction})"> <summary> Initializes a new instance of the IndexBatch class. </summary> <param name="actions">The index actions to include in the batch.</param> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Delete(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Creates a new IndexBatch for deleting a batch of documents. </summary> <param name="keyName">The name of the key field that uniquely identifies documents in the index.</param> <param name="keyValues">The keys of the documents to delete.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Delete(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.Document})"> <summary> Creates a new IndexBatch for deleting a batch of documents. </summary> <param name="documents">The documents to delete; Fields other than the key are ignored.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Delete``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Creates a new IndexBatch for deleting a batch of documents. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="documents">The documents to delete; Fields other than the key are ignored.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Merge(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.Document})"> <summary> Creates a new IndexBatch for merging documents into existing documents in the index. </summary> <param name="documents">The documents to merge; Set only the fields that you want to change.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Merge``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Creates a new IndexBatch for merging documents into existing documents in the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="documents">The documents to merge; Set only the properties that you want to change.</param> <returns>A new IndexBatch.</returns> <remarks> If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for bool), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare value-typed properties to be nullable in type T. </remarks> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.MergeOrUpload(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.Document})"> <summary> Creates a new IndexBatch for uploading documents to the index, or merging them into existing documents for those that already exist in the index. </summary> <param name="documents">The documents to merge or upload.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.MergeOrUpload``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Creates a new IndexBatch for uploading documents to the index, or merging them into existing documents for those that already exist in the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="documents">The documents to merge or upload.</param> <returns>A new IndexBatch.</returns> <remarks> If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for bool), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare value-typed properties to be nullable in type T. </remarks> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.New(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.IndexAction})"> <summary> Creates a new instance of the IndexBatch class. </summary> <param name="actions">The index actions to include in the batch.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.New``1(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.IndexAction{``0}})"> <summary> Creates a new instance of the IndexBatch class. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="actions">The index actions to include in the batch.</param> <returns>A new IndexBatch.</returns> <remarks> You can use this method as a convenience if you don't want to explicitly specify your model class as a type parameter. </remarks> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Upload(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.Document})"> <summary> Creates a new IndexBatch for uploading documents to the index. </summary> <param name="documents">The documents to upload.</param> <returns>A new IndexBatch.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch.Upload``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Creates a new IndexBatch for uploading documents to the index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="documents">The documents to upload.</param> <returns>A new IndexBatch.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.IndexBatchBase`2"> <summary> Abstract base class for batches of upload, merge, and/or delete actions to send to the Azure Search index. </summary> <typeparam name="TAction"> The type of action to be contained in the batch. Must be derived from IndexActionBase. </typeparam> <typeparam name="TDoc"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatchBase`2.#ctor(System.Collections.Generic.IEnumerable{`0})"> <summary> Initializes a new instance of the IndexBatchBase class. </summary> <param name="actions">The index actions to include in the batch.</param> </member> <member name="P:Microsoft.Azure.Search.Models.IndexBatchBase`2.Actions"> <summary> Gets the sequence of actions in the batch. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexBatch`1"> <summary> Contains a batch of upload, merge, and/or delete actions to send to the Azure Search index. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.IndexBatch`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Azure.Search.Models.IndexAction{`0}})"> <summary> Initializes a new instance of the IndexBatch class. </summary> <param name="actions">The index actions to include in the batch.</param> </member> <member name="T:Microsoft.Azure.Search.Models.IndexingResult"> <summary> Status of an indexing operation for a single document. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingResult.#ctor"> <summary> Initializes a new instance of the IndexingResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingResult.#ctor(System.String,System.String,System.Boolean,System.Int32)"> <summary> Initializes a new instance of the IndexingResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingResult.Key"> <summary> Gets the key of a document that was in the indexing request. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingResult.ErrorMessage"> <summary> Gets the error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingResult.Succeeded"> <summary> Gets a value indicating whether the indexing operation succeeded for the document identified by the key. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingResult.StatusCode"> <summary> Gets the status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.KeywordTokenizer"> <summary> Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizer.#ctor"> <summary> Initializes a new instance of the KeywordTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizer.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the KeywordTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeywordTokenizer.BufferSize"> <summary> Gets or sets the read buffer size in bytes. Default is 256. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.NGramTokenFilter"> <summary> Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilter.#ctor"> <summary> Initializes a new instance of the NGramTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the NGramTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenFilter.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. Must be less than the value of minGram. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenFilter.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.RangeFacetResult`1"> <summary> A single bucket of a range facet query result that reports the number of documents with a field value falling within a particular range. </summary> <typeparam name="T"> A type that matches the type of the field to which the facet was applied. Valid types include <c cref="T:System.DateTimeOffset">DateTimeOffset</c>, <c cref="T:System.Double">Double</c>, and <c cref="T:System.Int64">Int64</c> (long in C#). </typeparam> </member> <member name="P:Microsoft.Azure.Search.Models.RangeFacetResult`1.Count"> <summary> Gets the approximate count of documents falling within the bucket described by this facet. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.RangeFacetResult`1.From"> <summary> Gets a value indicating the inclusive lower bound of the facet's range, or null to indicate that there is no lower bound (i.e. -- for the first bucket). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.RangeFacetResult`1.To"> <summary> Gets a value indicating the exclusive upper bound of the facet's range, or null to indicate that there is no upper bound (i.e. -- for the last bucket). </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ScoringParameter"> <summary> Represents a parameter value to be used in scoring functions (for example, referencePointParameter). </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringParameter.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Initializes a new instance of the ScoringParameter class with the given name and string values. </summary> <param name="name">Name of the scoring parameter.</param> <param name="values">Values of the scoring parameter.</param> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringParameter.#ctor(System.String,Microsoft.Spatial.GeographyPoint)"> <summary> Initializes a new instance of the ScoringParameter class with the given name and GeographyPoint value. </summary> <param name="name">Name of the scoring parameter.</param> <param name="value">Value of the scoring parameter.</param> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringParameter.Name"> <summary> Gets the name of the scoring parameter. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringParameter.Values"> <summary> Gets the values of the scoring parameter. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringParameter.ToString"> <summary> Returns the scoring parameter in a format that can be used in a Search API request. </summary> <returns> The scoring parameter as a colon-separated name-value pair (for example, mylocation:-122.2,44.8) </returns> </member> <member name="T:Microsoft.Azure.Search.Models.SearchContinuationToken"> <summary> Encapsulates state required to continue fetching search results. This is necessary when Azure Search cannot fulfill a search request with a single response. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SearchParameters"> <summary> Parameters for filtering, sorting, faceting, paging, and other search query behaviors. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchParameters.#ctor"> <summary> Initializes a new instance of the SearchParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.Facets"> <summary> Gets or sets the list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.Filter"> <summary> Gets or sets the OData $filter expression to apply to the search query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.HighlightFields"> <summary> Gets or sets the list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.HighlightPostTag"> <summary> Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. Default is &lt;/em&gt;. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.HighlightPreTag"> <summary> Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. Default is &lt;em&gt;. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.IncludeTotalResultCount"> <summary> Gets or sets a value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.MinimumCoverage"> <summary> Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.OrderBy"> <summary> Gets or sets the list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.QueryType"> <summary> Gets or sets a value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. Possible values for this property include: 'simple', 'full'. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.ScoringParameters"> <summary> Gets or sets the list of parameter values to be used in scoring functions (for example, referencePointParameter). Each parameter is a name/value pair encapsulated in a ScoringParameter object. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.ScoringProfile"> <summary> Gets or sets the name of a scoring profile to evaluate match scores for matching documents in order to sort the results. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.SearchFields"> <summary> Gets or sets the list of field names to include in the full-text search. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.SearchMode"> <summary> Gets or sets a value that specifies whether any or all of the search terms must be matched in order to count the document as a match. Possible values for this property include: 'any', 'all'. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.Select"> <summary> Gets or sets the list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.Skip"> <summary> Gets or sets the number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using OrderBy on a totally-ordered key and Filter with a range query instead. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParameters.Top"> <summary> Gets or sets the number of search results to retrieve. This can be used in conjunction with Skip to implement client-side paging of search results. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchParameters.ToString"> <summary> Converts the SearchParameters instance to a URL query string. </summary> <returns>A URL query string containing all the search parameters.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.SearchResult"> <summary> Contains a document found by a search query, plus associated metadata. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchResult.#ctor"> <summary> Initializes a new instance of the SearchResult class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SearchResultBase`1"> <summary> Abstract base class for a result containing a document found by a search query, plus associated metadata. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.SearchResultBase`1.#ctor"> <summary> Initializes a new instance of the SearchResultBase class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchResultBase`1.Score"> <summary> Gets the relevance score of the document compared to other documents returned by the query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchResultBase`1.Highlights"> <summary> Gets text snippets from the document that indicate the matching search terms; null if hit highlighting was not enabled for the query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchResultBase`1.Document"> <summary> Gets the document found by the search query. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SearchResult`1"> <summary> Contains a document found by a search query, plus associated metadata. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.SearchResult`1.#ctor"> <summary> Initializes a new instance of the SearchResult class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SerializePropertyNamesAsCamelCaseAttribute"> <summary> Indicates that the public properties of a model class should be serialized as camel-case in order to match the field names of an Azure Search index. </summary> <remarks> Classes without this attribute are expected to have property names that exactly match their corresponding fields names in Azure Search. Otherwise, it would not be possible to use instances of the class to populate the index. </remarks> </member> <member name="T:Microsoft.Azure.Search.Models.StandardTokenizer"> <summary> Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizer.#ctor"> <summary> Initializes a new instance of the StandardTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizer.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the StandardTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StandardTokenizer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 255. Tokens longer than the maximum length are split </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.SuggestParameters"> <summary> Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestParameters.#ctor"> <summary> Initializes a new instance of the SuggestParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.Filter"> <summary> Gets or sets the OData $filter expression to apply to the suggestions query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.HighlightPostTag"> <summary> Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting of suggestions is disabled. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.HighlightPreTag"> <summary> Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting of suggestions is disabled. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.MinimumCoverage"> <summary> Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.OrderBy"> <summary> Gets or sets the list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.SearchFields"> <summary> Gets or sets the list of field names to consider when querying for suggestions. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.Select"> <summary> Gets or sets the list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.Top"> <summary> Gets or sets the number of suggestions to retrieve. This must be a value between 1 and 100. The default is to 5. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParameters.UseFuzzyMatching"> <summary> Gets or sets a value indicating whether to use fuzzy matching for the suggestion query. Default is false. when set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestParameters.ToString"> <summary> Converts the SuggestParameters instance to a URL query string. </summary> <returns>A URL query string containing all the suggestion parameters.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.SuggestResult"> <summary> Contains a document found by a suggestion query, plus associated metadata. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestResult.#ctor"> <summary> Initializes a new instance of the SuggestResult class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SuggestResultBase`1"> <summary> Abstract base class for a result containing a document found by a suggestion query, plus associated metadata. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestResultBase`1.#ctor"> <summary> Initializes a new instance of the SuggestResultBase class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestResultBase`1.Text"> <summary> Gets the text of the suggestion result. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestResultBase`1.Document"> <summary> Gets the document on which the suggested text is based. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SuggestResult`1"> <summary> Contains a document found by a suggestion query, plus associated metadata. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestResult`1.#ctor"> <summary> Initializes a new instance of the SuggestResult class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ValueFacetResult`1"> <summary> A single bucket of a simple or interval facet query result that reports the number of documents with a field falling within a particular interval or having a specific value. </summary> <typeparam name="T"> A type that matches the type of the field to which the facet was applied. </typeparam> </member> <member name="P:Microsoft.Azure.Search.Models.ValueFacetResult`1.Count"> <summary> Gets the approximate count of documents falling within the bucket described by this facet. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ValueFacetResult`1.Value"> <summary> Gets the value of the facet, or the inclusive lower bound if it's an interval facet. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.BlobExtractionMode"> <summary> Defines which parts of a blob will be indexed by the blob storage indexer. <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.BlobExtractionMode.StorageMetadata"> <summary> Specifies that only the standard blob properties and user-specified metadata will be indexed. <see href="https://docs.microsoft.com/azure/storage/storage-properties-metadata" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.BlobExtractionMode.AllMetadata"> <summary> Specifies that storage metadata and the content-type specific metadata extracted from the blob content will be indexed. <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#content-type-specific-metadata-properties" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.BlobExtractionMode.ContentAndMetadata"> <summary> Specifies that all metadata and textual content extracted from the blob will be indexed. This is the default value. <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#document-extraction-process"/> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.BlobExtractionMode.Create(System.String)"> <summary> Creates a new BlobExtractionMode instance, or returns an existing instance if the given name matches that of a known blob extraction mode. </summary> <param name="name">Name of the blob extraction mode.</param> <returns>A BlobExtractionMode instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.BlobExtractionMode.op_Implicit(System.String)~Microsoft.Azure.Search.Models.BlobExtractionMode"> <summary> Defines implicit conversion from string to BlobExtractionMode. </summary> <param name="name">string to convert.</param> <returns>The string as a BlobExtractionMode.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.FieldMapping"> <summary> Defines a mapping between a field in a data source and a target field in an index. <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMapping.#ctor(System.String,Microsoft.Azure.Search.Models.FieldMappingFunction)"> <summary> Initializes a new instance of the FieldMapping class. </summary> <param name="sourceFieldName">The name of the field in the data source.</param> <param name="mappingFunction">A function to apply to each source field value before indexing.</param> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMapping.#ctor"> <summary> Initializes a new instance of the FieldMapping class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMapping.#ctor(System.String,System.String,Microsoft.Azure.Search.Models.FieldMappingFunction)"> <summary> Initializes a new instance of the FieldMapping class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FieldMapping.SourceFieldName"> <summary> Gets or sets the name of the field in the data source. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FieldMapping.TargetFieldName"> <summary> Gets or sets the name of the target field in the index. Same as the source field name by default. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FieldMapping.MappingFunction"> <summary> Gets or sets a function to apply to each source field value before indexing. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMapping.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.FieldMappingFunction"> <summary> Represents a function that transforms a value from a data source before indexing. <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode"> <summary> Creates a field mapping function that performs URL-safe Base64 encoding of the input string. Assumes that the input is UTF-8 encoded. </summary> <remarks> Sample use case: Only URL-safe characters can appear in an Azure Search document key (because customers must be able to address the document using the Lookup API, for example). If your data contains URL-unsafe characters and you want to use it to populate a key field in your search index, use this function. </remarks> <returns>A new field mapping function.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode"> <summary> Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed to a URL-safe Base64-encoded string. </summary> <remarks> Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can use this function to turn the encoded data back into "regular" strings when populating your search index. </remarks> <returns>A new field mapping function.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.ExtractTokenAtPosition(System.String,System.Int32)"> <summary> Creates a field mapping function that splits a string field using the specified delimiter, and picks the token at the specified position in the resulting split. </summary> <param name="delimiter">A string to use as the separator when splitting the input string.</param> <param name="position">An integer zero-based position of the token to pick after the input string is split.</param> <remarks> <para> For example, if the input is Jane Doe, the delimiter is " " (space) and the position is 0, the result is Jane; if the position is 1, the result is Doe. If the position refers to a token that doesn't exist, an error will be returned. </para> <para> Sample use case: Your data source contains a PersonName field, and you want to index it as two separate FirstName and LastName fields. You can use this function to split the input using the space character as the delimiter. </para> </remarks> <returns>A new field mapping function.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.JsonArrayToStringCollection"> <summary> Creates a field mapping function that transforms a string formatted as a JSON array of strings into a string array that can be used to populate a Collection(Edm.String) field in the index. </summary> <remarks> <para> For example, if the input string is ["red", "white", "blue"], then the target field of type Collection(Edm.String) will be populated with the three values red, white and blue. For input values that cannot be parsed as JSON string arrays, an error will be returned. </para> <para> Sample use case: Azure SQL database doesn't have a built-in data type that naturally maps to Collection(Edm.String) fields in Azure Search. To populate string collection fields, format your source data as a JSON string array and use this function. </para> </remarks> <returns>A new field mapping function.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.#ctor"> <summary> Initializes a new instance of the FieldMappingFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Initializes a new instance of the FieldMappingFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FieldMappingFunction.Name"> <summary> Gets or sets the name of the field mapping function. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FieldMappingFunction.Parameters"> <summary> Gets or sets a dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.Indexer"> <summary> Represents an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Indexer.#ctor"> <summary> Initializes a new instance of the Indexer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Indexer.#ctor(System.String,System.String,System.String,System.String,Microsoft.Azure.Search.Models.IndexingSchedule,Microsoft.Azure.Search.Models.IndexingParameters,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.FieldMapping},System.Nullable{System.Boolean},System.String)"> <summary> Initializes a new instance of the Indexer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.Name"> <summary> Gets or sets the name of the indexer. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.Description"> <summary> Gets or sets the description of the indexer. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.DataSourceName"> <summary> Gets or sets the name of the datasource from which this indexer reads data. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.TargetIndexName"> <summary> Gets or sets the name of the index to which this indexer writes data. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.Schedule"> <summary> Gets or sets the schedule for this indexer. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.Parameters"> <summary> Gets or sets parameters for indexer execution. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.FieldMappings"> <summary> Gets or sets defines mappings between fields in the data source and corresponding target fields in the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.IsDisabled"> <summary> Gets or sets a value indicating whether the indexer is disabled. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Indexer.ETag"> <summary> Gets or sets the ETag of the Indexer. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Indexer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.IndexerExecutionInfo"> <summary> Represents the current status and execution history of an indexer. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerExecutionInfo.#ctor"> <summary> Initializes a new instance of the IndexerExecutionInfo class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerExecutionInfo.#ctor(Microsoft.Azure.Search.Models.IndexerStatus,Microsoft.Azure.Search.Models.IndexerExecutionResult,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.IndexerExecutionResult})"> <summary> Initializes a new instance of the IndexerExecutionInfo class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionInfo.Status"> <summary> Overall indexer status. Possible values for this property include: 'unknown', 'error', 'running'. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionInfo.LastResult"> <summary> The result of the most recent or an in-progress indexer execution. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionInfo.ExecutionHistory"> <summary> History of the recent indexer executions, sorted in reverse chronological order. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexerExecutionResult"> <summary> Represents the result of an individual indexer execution. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerExecutionResult.#ctor"> <summary> Initializes a new instance of the IndexerExecutionResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerExecutionResult.#ctor(Microsoft.Azure.Search.Models.IndexerExecutionStatus,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.ItemError},System.Int32,System.Int32,System.String,System.String)"> <summary> Initializes a new instance of the IndexerExecutionResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.Status"> <summary> Gets the outcome of this indexer execution. Possible values for this property include: 'transientFailure', 'success', 'inProgress', 'reset'. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.ErrorMessage"> <summary> Gets the error message indicating the top-level error, if any. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.StartTime"> <summary> Gets the start time of this indexer execution. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.EndTime"> <summary> Gets the end time of this indexer execution, if the execution has already completed. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.Errors"> <summary> Gets the item-level indexing errors </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.ItemCount"> <summary> Gets the number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.FailedItemCount"> <summary> Gets the number of items that failed to be indexed during this indexer execution. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.InitialTrackingState"> <summary> Change tracking state with which an indexer execution started. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerExecutionResult.FinalTrackingState"> <summary> Change tracking state with which an indexer execution finished. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexingParameters"> <summary> Represents parameters for indexer execution. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParameters.#ctor"> <summary> Initializes a new instance of the IndexingParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParameters.#ctor(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Initializes a new instance of the IndexingParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingParameters.BatchSize"> <summary> Gets or sets the number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingParameters.MaxFailedItems"> <summary> Gets or sets the maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingParameters.MaxFailedItemsPerBatch"> <summary> Gets or sets the maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingParameters.Base64EncodeKeys"> <summary> Gets or sets whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingParameters.Configuration"> <summary> Gets or sets a dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexingParametersExtensions"> <summary> Defines extension methods for the IndexingParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.IndexStorageMetadataOnly(Microsoft.Azure.Search.Models.IndexingParameters)"> <summary> Specifies that the indexer will index only the storage metadata and completely skip the document extraction process. This is useful when you don't need the document content, nor do you need any of the content type-specific metadata properties. See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> for details. </summary> <param name="parameters">IndexingParameters to configure.</param> <remarks> This option only applies to indexers that index Azure Blob Storage. </remarks> <returns>The IndexingParameters instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.IndexFileNameExtensions(Microsoft.Azure.Search.Models.IndexingParameters,System.String[])"> <summary> Specifies that the indexer will index only the blobs with the file name extensions you specify. Each string is a file extensions with a leading dot. For example, ".pdf", ".docx", etc. If you pass the same file extension to this method and ExcludeFileNameExtensions, blobs with that extension will be excluded from indexing (that is, ExcludeFileNameExtensions takes precedence). See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> for details. </summary> <param name="parameters">IndexingParameters to configure.</param> <param name="extensions">File extensions to include in indexing.</param> <remarks> This option only applies to indexers that index Azure Blob Storage. </remarks> <returns>The IndexingParameters instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.ExcludeFileNameExtensions(Microsoft.Azure.Search.Models.IndexingParameters,System.String[])"> <summary> Specifies that the indexer will not index blobs with the file name extensions you specify. Each string is a file extensions with a leading dot. For example, ".pdf", ".docx", etc. If you pass the same file extension to this method and IndexFileNameExtensions, blobs with that extension will be excluded from indexing (that is, this method takes precedence). See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> for details. </summary> <param name="parameters">IndexingParameters to configure.</param> <param name="extensions">File extensions to exclude from indexing.</param> <remarks> This option only applies to indexers that index Azure Blob Storage. </remarks> <returns>The IndexingParameters instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.SkipContent(Microsoft.Azure.Search.Models.IndexingParameters)"> <summary> Specifies that the indexer will extract metadata, but skip content extraction for all blobs. If you want to skip content extraction for only some blobs, add AzureSearch_SkipContent metadata to those blobs individually instead of using this option. See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> for details. </summary> <param name="parameters">IndexingParameters to configure.</param> <remarks> This option only applies to indexers that index Azure Blob Storage. </remarks> <returns>The IndexingParameters instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.SetBlobExtractionMode(Microsoft.Azure.Search.Models.IndexingParameters,Microsoft.Azure.Search.Models.BlobExtractionMode)"> <summary> Specifies which parts of a blob will be indexed by the blob storage indexer. </summary> <remarks> This option only applies to indexers that index Azure Blob Storage. <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage" /> </remarks> <param name="parameters">IndexingParameters to configure.</param> <param name="extractionMode">A <c cref="T:Microsoft.Azure.Search.Models.BlobExtractionMode">BlobExtractionMode</c> value specifying what to index.</param> <returns>The IndexingParameters instance.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingParametersExtensions.DoNotFailOnUnsupportedContentType(Microsoft.Azure.Search.Models.IndexingParameters)"> <summary> Specifies that <c cref="F:Microsoft.Azure.Search.Models.BlobExtractionMode.StorageMetadata">BlobExtractionMode.StorageMetadata</c> blob extraction mode will be automatically used for blobs of unsupported content types. The default is false. </summary> <remarks> This option only applies to indexers that index Azure Blob Storage. </remarks> <param name="parameters">IndexingParameters to configure.</param> <returns></returns> <returns>The IndexingParameters instance.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.AnalyzerName"> <summary> Defines the names of all text analyzers supported by Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Language-support"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ArMicrosoft"> <summary> Microsoft analyzer for Arabic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ArLucene"> <summary> Lucene analyzer for Arabic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HyLucene"> <summary> Lucene analyzer for Armenian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.BnMicrosoft"> <summary> Microsoft analyzer for Bangla. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EuLucene"> <summary> Lucene analyzer for Basque. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.BgMicrosoft"> <summary> Microsoft analyzer for Bulgarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.BgLucene"> <summary> Lucene analyzer for Bulgarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.CaMicrosoft"> <summary> Microsoft analyzer for Catalan. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.CaLucene"> <summary> Lucene analyzer for Catalan. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ZhHansMicrosoft"> <summary> Microsoft analyzer for Chinese (Simplified). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ZhHansLucene"> <summary> Lucene analyzer for Chinese (Simplified). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ZhHantMicrosoft"> <summary> Microsoft analyzer for Chinese (Traditional). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ZhHantLucene"> <summary> Lucene analyzer for Chinese (Traditional). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HrMicrosoft"> <summary> Microsoft analyzer for Croatian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.CsMicrosoft"> <summary> Microsoft analyzer for Czech. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.CsLucene"> <summary> Lucene analyzer for Czech. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.DaMicrosoft"> <summary> Microsoft analyzer for Danish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.DaLucene"> <summary> Lucene analyzer for Danish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.NlMicrosoft"> <summary> Microsoft analyzer for Dutch. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.NlLucene"> <summary> Lucene analyzer for Dutch. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EnMicrosoft"> <summary> Microsoft analyzer for English. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EnLucene"> <summary> Lucene analyzer for English. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EtMicrosoft"> <summary> Microsoft analyzer for Estonian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.FiMicrosoft"> <summary> Microsoft analyzer for Finnish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.FiLucene"> <summary> Lucene analyzer for Finnish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.FrMicrosoft"> <summary> Microsoft analyzer for French. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.FrLucene"> <summary> Lucene analyzer for French. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.GlLucene"> <summary> Lucene analyzer for Galician. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.DeMicrosoft"> <summary> Microsoft analyzer for German. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.DeLucene"> <summary> Lucene analyzer for German. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ElMicrosoft"> <summary> Microsoft analyzer for Greek. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ElLucene"> <summary> Lucene analyzer for Greek. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.GuMicrosoft"> <summary> Microsoft analyzer for Gujarati. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HeMicrosoft"> <summary> Microsoft analyzer for Hebrew. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HiMicrosoft"> <summary> Microsoft analyzer for Hindi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HiLucene"> <summary> Lucene analyzer for Hindi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HuMicrosoft"> <summary> Microsoft analyzer for Hungarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.HuLucene"> <summary> Lucene analyzer for Hungarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.IsMicrosoft"> <summary> Microsoft analyzer for Icelandic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.IdMicrosoft"> <summary> Microsoft analyzer for Indonesian (Bahasa). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.IdLucene"> <summary> Lucene analyzer for Indonesian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.GaLucene"> <summary> Lucene analyzer for Irish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ItMicrosoft"> <summary> Microsoft analyzer for Italian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ItLucene"> <summary> Lucene analyzer for Italian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.JaMicrosoft"> <summary> Microsoft analyzer for Japanese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.JaLucene"> <summary> Lucene analyzer for Japanese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.KnMicrosoft"> <summary> Microsoft analyzer for Kannada. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.KoMicrosoft"> <summary> Microsoft analyzer for Korean. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.KoLucene"> <summary> Lucene analyzer for Korean. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.LvMicrosoft"> <summary> Microsoft analyzer for Latvian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.LvLucene"> <summary> Lucene analyzer for Latvian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.LtMicrosoft"> <summary> Microsoft analyzer for Lithuanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.MlMicrosoft"> <summary> Microsoft analyzer for Malayalam. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.MsMicrosoft"> <summary> Microsoft analyzer for Malay (Latin). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.MrMicrosoft"> <summary> Microsoft analyzer for Marathi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.NbMicrosoft"> <summary> Microsoft analyzer for Norwegian (Bokmål). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.NoLucene"> <summary> Lucene analyzer for Norwegian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.FaLucene"> <summary> Lucene analyzer for Persian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PlMicrosoft"> <summary> Microsoft analyzer for Polish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PlLucene"> <summary> Lucene analyzer for Polish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PtBrMicrosoft"> <summary> Microsoft analyzer for Portuguese (Brazil). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PtBRLucene"> <summary> Lucene analyzer for Portuguese (Brazil). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PtPtMicrosoft"> <summary> Microsoft analyzer for Portuguese (Portugal). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PtPTLucene"> <summary> Lucene analyzer for Portuguese (Portugal). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.PaMicrosoft"> <summary> Microsoft analyzer for Punjabi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.RoMicrosoft"> <summary> Microsoft analyzer for Romanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.RoLucene"> <summary> Lucene analyzer for Romanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.RuMicrosoft"> <summary> Microsoft analyzer for Russian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.RuLucene"> <summary> Lucene analyzer for Russian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SrCyrillicMicrosoft"> <summary> Microsoft analyzer for Serbian (Cyrillic). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SrLatinMicrosoft"> <summary> Microsoft analyzer for Serbian (Latin). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SkMicrosoft"> <summary> Microsoft analyzer for Slovak. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SlMicrosoft"> <summary> Microsoft analyzer for Slovenian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EsMicrosoft"> <summary> Microsoft analyzer for Spanish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.EsLucene"> <summary> Lucene analyzer for Spanish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SvMicrosoft"> <summary> Microsoft analyzer for Swedish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.SvLucene"> <summary> Lucene analyzer for Swedish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.TaMicrosoft"> <summary> Microsoft analyzer for Tamil. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.TeMicrosoft"> <summary> Microsoft analyzer for Telugu. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ThMicrosoft"> <summary> Microsoft analyzer for Thai. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ThLucene"> <summary> Lucene analyzer for Thai. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.TrMicrosoft"> <summary> Microsoft analyzer for Turkish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.TrLucene"> <summary> Lucene analyzer for Turkish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.UkMicrosoft"> <summary> Microsoft analyzer for Ukranian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.UrMicrosoft"> <summary> Microsoft analyzer for Urdu. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.ViMicrosoft"> <summary> Microsoft analyzer for Vietnamese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.StandardLucene"> <summary> Standard Lucene analyzer. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.StandardAsciiFoldingLucene"> <summary> Standard ASCII Folding Lucene analyzer. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.Keyword"> <summary> Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.Pattern"> <summary> Flexibly separates text into terms via a regular expression pattern. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.Simple"> <summary> Divides text at non-letters and converts them to lower case. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.Stop"> <summary> Divides text at non-letters; Applies the lowercase and stopword token filters. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.Whitespace"> <summary> An analyzer that uses the whitespace tokenizer. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" /> </summary> </member> <member name="T:Microsoft.Azure.Search.Models.AnalyzerName.AsString"> <summary> The names of all of the analyzers as plain strings. </summary> <remarks> When defining an index with an attributed model, you need to specify analyzers by name, because .NET custom attributes cannot be constructed with a reference to a static field. (Only constant values from a limited range of types are supported.) </remarks> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ArMicrosoft"> <summary> Microsoft analyzer for Arabic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ArLucene"> <summary> Lucene analyzer for Arabic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HyLucene"> <summary> Lucene analyzer for Armenian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.BnMicrosoft"> <summary> Microsoft analyzer for Bangla. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EuLucene"> <summary> Lucene analyzer for Basque. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.BgMicrosoft"> <summary> Microsoft analyzer for Bulgarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.BgLucene"> <summary> Lucene analyzer for Bulgarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.CaMicrosoft"> <summary> Microsoft analyzer for Catalan. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.CaLucene"> <summary> Lucene analyzer for Catalan. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ZhHansMicrosoft"> <summary> Microsoft analyzer for Chinese (Simplified). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ZhHansLucene"> <summary> Lucene analyzer for Chinese (Simplified). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ZhHantMicrosoft"> <summary> Microsoft analyzer for Chinese (Traditional). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ZhHantLucene"> <summary> Lucene analyzer for Chinese (Traditional). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HrMicrosoft"> <summary> Microsoft analyzer for Croatian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.CsMicrosoft"> <summary> Microsoft analyzer for Czech. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.CsLucene"> <summary> Lucene analyzer for Czech. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.DaMicrosoft"> <summary> Microsoft analyzer for Danish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.DaLucene"> <summary> Lucene analyzer for Danish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.NlMicrosoft"> <summary> Microsoft analyzer for Dutch. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.NlLucene"> <summary> Lucene analyzer for Dutch. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EnMicrosoft"> <summary> Microsoft analyzer for English. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EnLucene"> <summary> Lucene analyzer for English. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EtMicrosoft"> <summary> Microsoft analyzer for Estonian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.FiMicrosoft"> <summary> Microsoft analyzer for Finnish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.FiLucene"> <summary> Lucene analyzer for Finnish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.FrMicrosoft"> <summary> Microsoft analyzer for French. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.FrLucene"> <summary> Lucene analyzer for French. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.GlLucene"> <summary> Lucene analyzer for Galician. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.DeMicrosoft"> <summary> Microsoft analyzer for German. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.DeLucene"> <summary> Lucene analyzer for German. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ElMicrosoft"> <summary> Microsoft analyzer for Greek. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ElLucene"> <summary> Lucene analyzer for Greek. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.GuMicrosoft"> <summary> Microsoft analyzer for Gujarati. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HeMicrosoft"> <summary> Microsoft analyzer for Hebrew. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HiMicrosoft"> <summary> Microsoft analyzer for Hindi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HiLucene"> <summary> Lucene analyzer for Hindi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HuMicrosoft"> <summary> Microsoft analyzer for Hungarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.HuLucene"> <summary> Lucene analyzer for Hungarian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.IsMicrosoft"> <summary> Microsoft analyzer for Icelandic. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.IdMicrosoft"> <summary> Microsoft analyzer for Indonesian (Bahasa). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.IdLucene"> <summary> Lucene analyzer for Indonesian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.GaLucene"> <summary> Lucene analyzer for Irish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ItMicrosoft"> <summary> Microsoft analyzer for Italian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ItLucene"> <summary> Lucene analyzer for Italian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.JaMicrosoft"> <summary> Microsoft analyzer for Japanese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.JaLucene"> <summary> Lucene analyzer for Japanese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.KnMicrosoft"> <summary> Microsoft analyzer for Kannada. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.KoMicrosoft"> <summary> Microsoft analyzer for Korean. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.KoLucene"> <summary> Lucene analyzer for Korean. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.LvMicrosoft"> <summary> Microsoft analyzer for Latvian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.LvLucene"> <summary> Lucene analyzer for Latvian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.LtMicrosoft"> <summary> Microsoft analyzer for Lithuanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.MlMicrosoft"> <summary> Microsoft analyzer for Malayalam. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.MsMicrosoft"> <summary> Microsoft analyzer for Malay (Latin). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.MrMicrosoft"> <summary> Microsoft analyzer for Marathi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.NbMicrosoft"> <summary> Microsoft analyzer for Norwegian (Bokmål). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.NoLucene"> <summary> Lucene analyzer for Norwegian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.FaLucene"> <summary> Lucene analyzer for Persian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PlMicrosoft"> <summary> Microsoft analyzer for Polish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PlLucene"> <summary> Lucene analyzer for Polish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PtBrMicrosoft"> <summary> Microsoft analyzer for Portuguese (Brazil). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PtBRLucene"> <summary> Lucene analyzer for Portuguese (Brazil). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PtPtMicrosoft"> <summary> Microsoft analyzer for Portuguese (Portugal). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PtPTLucene"> <summary> Lucene analyzer for Portuguese (Portugal). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.PaMicrosoft"> <summary> Microsoft analyzer for Punjabi. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.RoMicrosoft"> <summary> Microsoft analyzer for Romanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.RoLucene"> <summary> Lucene analyzer for Romanian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.RuMicrosoft"> <summary> Microsoft analyzer for Russian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.RuLucene"> <summary> Lucene analyzer for Russian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SrCyrillicMicrosoft"> <summary> Microsoft analyzer for Serbian (Cyrillic). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SrLatinMicrosoft"> <summary> Microsoft analyzer for Serbian (Latin). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SkMicrosoft"> <summary> Microsoft analyzer for Slovak. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SlMicrosoft"> <summary> Microsoft analyzer for Slovenian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EsMicrosoft"> <summary> Microsoft analyzer for Spanish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.EsLucene"> <summary> Lucene analyzer for Spanish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SvMicrosoft"> <summary> Microsoft analyzer for Swedish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.SvLucene"> <summary> Lucene analyzer for Swedish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.TaMicrosoft"> <summary> Microsoft analyzer for Tamil. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.TeMicrosoft"> <summary> Microsoft analyzer for Telugu. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ThMicrosoft"> <summary> Microsoft analyzer for Thai. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ThLucene"> <summary> Lucene analyzer for Thai. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.TrMicrosoft"> <summary> Microsoft analyzer for Turkish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.TrLucene"> <summary> Lucene analyzer for Turkish. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.UkMicrosoft"> <summary> Microsoft analyzer for Ukranian. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.UrMicrosoft"> <summary> Microsoft analyzer for Urdu. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.ViMicrosoft"> <summary> Microsoft analyzer for Vietnamese. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.StandardLucene"> <summary> Standard Lucene analyzer. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.StandardAsciiFoldingLucene"> <summary> Standard ASCII Folding Lucene analyzer. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.Keyword"> <summary> Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.Pattern"> <summary> Flexibly separates text into terms via a regular expression pattern. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.Simple"> <summary> Divides text at non-letters and converts them to lower case. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.Stop"> <summary> Divides text at non-letters; Applies the lowercase and stopword token filters. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.AnalyzerName.AsString.Whitespace"> <summary> An analyzer that uses the whitespace tokenizer. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzerName.Create(System.String)"> <summary> Creates a new AnalyzerName instance, or returns an existing instance if the given name matches that of a known analyzer. </summary> <param name="name">Name of the analyzer.</param> <returns>An AnalyzerName instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzerName.op_Implicit(System.String)~Microsoft.Azure.Search.Models.AnalyzerName"> <summary> Defines implicit conversion from string to AnalyzerName. </summary> <param name="name">string to convert.</param> <returns>The string as an AnalyzerName.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.CharFilterName"> <summary> Defines the names of all character filters supported by Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.CharFilterName.HtmlStrip"> <summary> A character filter that attempts to strip out HTML constructs. <see href="https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CharFilterName.Create(System.String)"> <summary> Creates a new CharFilterName instance, or returns an existing instance if the given name matches that of a known character filter. </summary> <param name="name">Name of the character filter.</param> <returns>A CharFilterName instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.CharFilterName.op_Implicit(System.String)~Microsoft.Azure.Search.Models.CharFilterName"> <summary> Defines implicit conversion from string to CharFilterName. </summary> <param name="name">string to convert.</param> <returns>The string as a CharFilterName.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.CjkBigramTokenFilter"> <summary> Forms bigrams of CJK terms that are generated from StandardTokenizer. This tokenizer is implemented using Apache Lucene. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CjkBigramTokenFilter.#ctor"> <summary> Initializes a new instance of the CjkBigramTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CjkBigramTokenFilter.#ctor(System.String,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.CjkBigramTokenFilterScripts},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the CjkBigramTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CjkBigramTokenFilter.IgnoreScripts"> <summary> Gets or sets the scripts to ignore. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CjkBigramTokenFilter.OutputUnigrams"> <summary> Gets or sets a value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CjkBigramTokenFilter.Validate"> <summary> Validate the object. Throws ValidationException if validation fails. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DataType"> <summary> Defines the data type of a field in an Azure Search index. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.String"> <summary> Indicates that a field contains a string. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.Int32"> <summary> Indicates that a field contains a 32-bit signed integer. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.Int64"> <summary> Indicates that a field contains a 64-bit signed integer. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.Double"> <summary> Indicates that a field contains an IEEE double-precision floating point number. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.Boolean"> <summary> Indicates that a field contains a Boolean value (true or false). </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.DateTimeOffset"> <summary> Indicates that a field contains a date/time value, including timezone information. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.DataType.GeographyPoint"> <summary> Indicates that a field contains a geo-location in terms of longitude and latitude. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataType.Create(System.String)"> <summary> Creates a new DataType instance, or returns an existing instance if the given name matches that of a known data type. </summary> <param name="name">Name of the data type.</param> <returns>A DataType instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataType.Collection(Microsoft.Azure.Search.Models.DataType)"> <summary> Creates a DataType for a collection of the given type. </summary> <param name="elementType">The DataType of the elements of the collection.</param> <returns>A new DataType for a collection.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.DataType.op_Implicit(System.String)~Microsoft.Azure.Search.Models.DataType"> <summary> Defines implicit conversion from string to DataType. </summary> <param name="name">string to convert.</param> <returns>The string as a DataType.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.DistanceScoringFunction"> <summary> Defines a function that boosts scores based on distance from a geographic location. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringFunction.#ctor(System.String,System.Double,System.String,System.Double,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the DistanceScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringFunction.#ctor"> <summary> Initializes a new instance of the DistanceScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringFunction.#ctor(System.String,System.Double,Microsoft.Azure.Search.Models.DistanceScoringParameters,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the DistanceScoringFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DistanceScoringFunction.Parameters"> <summary> Gets or sets parameter values for the distance scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.EdgeNGramTokenizer"> <summary> Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.#ctor"> <summary> Initializes a new instance of the EdgeNGramTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenCharacterKind})"> <summary> Initializes a new instance of the EdgeNGramTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.TokenChars"> <summary> Gets or sets character classes to keep in the tokens. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenizer.Validate"> <summary> Validate the object. Throws ValidationException if validation fails. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.Field"> <summary> Represents a field in an index definition in Azure Search, which describes the name, data type, and search behavior of a field. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Field.#ctor"> <summary> Initializes a new instance of the Field class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.DataType)"> <summary> Initializes a new instance of the Field class with required arguments. </summary> <param name="name">The name of the field.</param> <param name="dataType">The data type of the field.</param> </member> <member name="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.AnalyzerName)"> <summary> Initializes a new instance of the Field class with required arguments. </summary> <param name="name">The name of the field.</param> <param name="analyzerName">The name of the analyzer to use for the field.</param> <remarks>The new field will automatically be searchable and of type Edm.String.</remarks> </member> <member name="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.DataType,Microsoft.Azure.Search.Models.AnalyzerName)"> <summary> Initializes a new instance of the Field class with required arguments. </summary> <param name="name">The name of the field.</param> <param name="dataType">The data type of the field.</param> <param name="analyzerName">The name of the analyzer to use for the field.</param> <remarks>The new field will automatically be searchable.</remarks> </member> <member name="P:Microsoft.Azure.Search.Models.Field.Name"> <summary> Gets or sets the name of the field. <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules" /> </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.Type"> <summary> Gets or sets the data type of the field. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.Analyzer"> <summary> Gets or sets the name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either SearchAnalyzer or IndexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. <see href="https://docs.microsoft.com/rest/api/searchservice/Language-support" /> </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.SearchAnalyzer"> <summary> Gets or sets the name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with IndexAnalyzer and it cannot be set together with the Analyzer option. This analyzer can be updated on an existing field. <see href="https://docs.microsoft.com/rest/api/searchservice/Language-support" /> </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IndexAnalyzer"> <summary> Gets or sets the name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with SearchAnalyzer and it cannot be set together with the Analyzer option. Once the analyzer is chosen, it cannot be changed for the field. <see href="https://docs.microsoft.com/rest/api/searchservice/Language-support" /> </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsKey"> <summary> Gets or sets a value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsSearchable"> <summary> Gets or sets a value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsFilterable"> <summary> Gets or sets a value indicating whether the field can be used in filter expressions. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsSortable"> <summary> Gets or sets a value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsFacetable"> <summary> Gets or sets a value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Field.IsRetrievable"> <summary> Gets or sets a value indicating whether the field can be returned in a search result. Default is true. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Field.Validate"> <summary> Validate the object. Throws ValidationException if validation fails. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.FreshnessScoringFunction"> <summary> Defines a function that boosts scores based on the value of a date-time field. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringFunction.#ctor(System.String,System.Double,System.TimeSpan,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the FreshnessScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringFunction.#ctor"> <summary> Initializes a new instance of the FreshnessScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringFunction.#ctor(System.String,System.Double,Microsoft.Azure.Search.Models.FreshnessScoringParameters,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the FreshnessScoringFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FreshnessScoringFunction.Parameters"> <summary> Gets or sets parameter values for the freshness scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.Index"> <summary> Represents an index definition in Azure Search, which describes the fields and search behavior of an index. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Index.#ctor"> <summary> Initializes a new instance of the Index class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Index.#ctor(System.String,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Field},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.ScoringProfile},System.String,Microsoft.Azure.Search.Models.CorsOptions,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Suggester},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Analyzer},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Tokenizer},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenFilter},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.CharFilter},System.String)"> <summary> Initializes a new instance of the Index class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.Name"> <summary> Gets or sets the name of the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.Fields"> <summary> Gets or sets the fields of the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.ScoringProfiles"> <summary> Gets or sets the scoring profiles for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.DefaultScoringProfile"> <summary> Gets or sets the name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.CorsOptions"> <summary> Gets or sets options to control Cross-Origin Resource Sharing (CORS) for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.Suggesters"> <summary> Gets or sets the suggesters for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.Analyzers"> <summary> Gets or sets the analyzers for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.Tokenizers"> <summary> Gets or sets the tokenizers for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.TokenFilters"> <summary> Gets or sets the token filters for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.CharFilters"> <summary> Gets or sets the character filters for the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Index.ETag"> <summary> Gets or sets the ETag of the index. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Index.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.IndexGetStatisticsResult"> <summary> Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexGetStatisticsResult.#ctor"> <summary> Initializes a new instance of the IndexGetStatisticsResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexGetStatisticsResult.#ctor(System.Int64,System.Int64)"> <summary> Initializes a new instance of the IndexGetStatisticsResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexGetStatisticsResult.DocumentCount"> <summary> Gets the number of documents in the index. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexGetStatisticsResult.StorageSize"> <summary> Gets the amount of storage in bytes consumed by the index. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.MagnitudeScoringFunction"> <summary> Defines a function that boosts scores based on the magnitude of a numeric field. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringFunction.#ctor(System.String,System.Double,System.Double,System.Double,System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the MagnitudeScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringFunction.#ctor"> <summary> Initializes a new instance of the MagnitudeScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringFunction.#ctor(System.String,System.Double,Microsoft.Azure.Search.Models.MagnitudeScoringParameters,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the MagnitudeScoringFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MagnitudeScoringFunction.Parameters"> <summary> Gets or sets parameter values for the magnitude scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.NGramTokenizer"> <summary> Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenizer.#ctor"> <summary> Initializes a new instance of the NGramTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenizer.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenCharacterKind})"> <summary> Initializes a new instance of the NGramTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenizer.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenizer.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenizer.TokenChars"> <summary> Gets or sets character classes to keep in the tokens. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenizer.Validate"> <summary> Validate the object. Throws ValidationException if validation fails. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.PathHierarchyTokenizer"> <summary> Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.#ctor"> <summary> Initializes a new instance of the PathHierarchyTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.#ctor(System.String,System.Nullable{System.Char},System.Nullable{System.Char},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the PathHierarchyTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.Delimiter"> <summary> Gets or sets the delimiter character to use. Default is "/". </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.Replacement"> <summary> Gets or sets a value that, if set, replaces the delimiter character. Default is "/". </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.BufferSize"> <summary> Gets or sets the buffer size. Default is 1024. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.ReverseTokenOrder"> <summary> Gets or sets a value indicating whether to generate tokens in reverse order. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizer.NumberOfTokensToSkip"> <summary> Gets or sets the number of initial tokens to skip. Default is 0. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2"> <summary> Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.#ctor"> <summary> Initializes a new instance of the PathHierarchyTokenizerV2 class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.#ctor(System.String,System.Nullable{System.Char},System.Nullable{System.Char},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the PathHierarchyTokenizerV2 class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.Delimiter"> <summary> Gets or sets the delimiter character to use. Default is "/". </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.Replacement"> <summary> Gets or sets a value that, if set, replaces the delimiter character. Default is "/". </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 300. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.ReverseTokenOrder"> <summary> Gets or sets a value indicating whether to generate tokens in reverse order. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PathHierarchyTokenizerV2.NumberOfTokensToSkip"> <summary> Gets or sets the number of initial tokens to skip. Default is 0. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.RegexFlags"> <summary> Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.CanonEq"> <summary> Enables canonical equivalence. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#CANON_EQ"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.CaseInsensitive"> <summary> Enables case-insensitive matching. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#CASE_INSENSITIVE"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.Comments"> <summary> Permits whitespace and comments in the pattern. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#COMMENTS"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.DotAll"> <summary> Enables dotall mode. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#DOTALL"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.Literal"> <summary> Enables literal parsing of the pattern. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#LITERAL"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.Multiline"> <summary> Enables multiline mode. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#MULTILINE"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.UnicodeCase"> <summary> Enables Unicode-aware case folding. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#UNICODE_CASE"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.RegexFlags.UnixLines"> <summary> Enables Unix lines mode. <see href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#UNIX_LINES"/> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.RegexFlags.Create(System.String)"> <summary> Creates a new RegexFlags instance, or returns an existing instance if the given name matches that of a known regex flag. </summary> <param name="flagExpression"> Name of the regex flag, or an expression comprised of two or more flags separated by vertical bars (|). </param> <returns>A RegexFlags instance with the given expression.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.RegexFlags.op_BitwiseOr(Microsoft.Azure.Search.Models.RegexFlags,Microsoft.Azure.Search.Models.RegexFlags)"> <summary> Overloads the bitwise OR operator to combines two RegexFlags. </summary> <param name="lhs">The left-hand side of the OR expression.</param> <param name="rhs">The right-hand side of the OR expression.</param> <returns> A new RegexFlags that is the result of concatenating the two given RegexFlags, separated by a vertical bar (|). </returns> </member> <member name="M:Microsoft.Azure.Search.Models.RegexFlags.op_Implicit(System.String)~Microsoft.Azure.Search.Models.RegexFlags"> <summary> Defines implicit conversion from string to RegexFlags. </summary> <param name="name">string to convert.</param> <returns>The string as a RegexFlags.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.Suggester"> <summary> Defines how the Suggest API should apply to a group of fields in the index. </summary> <summary> Defines how the Suggest API should apply to a group of fields in the index. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Suggester.#ctor(System.String,Microsoft.Azure.Search.Models.SuggesterSearchMode,System.String[])"> <summary> Initializes a new instance of the Suggester class with required arguments. </summary> <param name="name">The name of the suggester.</param> <param name="searchMode">A value indicating the capabilities of the suggester.</param> <param name="sourceFields">The list of field names to which the suggester applies; Each field must be searchable.</param> </member> <member name="M:Microsoft.Azure.Search.Models.Suggester.#ctor"> <summary> Initializes a new instance of the Suggester class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Suggester.#ctor(System.String,Microsoft.Azure.Search.Models.SuggesterSearchMode,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the Suggester class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Suggester.Name"> <summary> Gets or sets the name of the suggester. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Suggester.SearchMode"> <summary> Gets or sets a value indicating the capabilities of the suggester. Possible values include: 'analyzingInfixMatching' </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Suggester.SourceFields"> <summary> Gets or sets the list of field names to which the suggester applies. Each field must be searchable. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Suggester.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TagScoringFunction"> <summary> Defines a function that boosts scores of documents with string values matching a given list of tags. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringFunction.#ctor(System.String,System.Double,System.String,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the TagScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringFunction.#ctor"> <summary> Initializes a new instance of the TagScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringFunction.#ctor(System.String,System.Double,Microsoft.Azure.Search.Models.TagScoringParameters,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the TagScoringFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TagScoringFunction.Parameters"> <summary> Gets or sets parameter values for the tag scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TextWeights"> <summary> Defines weights on index fields for which matches should boost scoring in search queries. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TextWeights.#ctor"> <summary> Initializes a new instance of the TextWeights class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TextWeights.#ctor(System.Collections.Generic.IDictionary{System.String,System.Double})"> <summary> Initializes a new instance of the TextWeights class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TextWeights.Weights"> <summary> Gets the dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TextWeights.Validate"> <summary> Validate the object. Throws ValidationException if validation fails. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.TokenFilterName"> <summary> Defines the names of all token filters supported by Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.ArabicNormalization"> <summary> A token filter that applies the Arabic normalizer to normalize the orthography. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Apostrophe"> <summary> Strips all characters after an apostrophe (including the apostrophe itself). <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.AsciiFolding"> <summary> Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.CjkBigram"> <summary> Forms bigrams of CJK terms that are generated from StandardTokenizer. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.CjkWidth"> <summary> Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Classic"> <summary> Removes English possessives, and dots from acronyms. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.CommonGram"> <summary> Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.EdgeNGram"> <summary> Generates n-grams of the given size(s) starting from the front or the back of an input token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Elision"> <summary> Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.GermanNormalization"> <summary> Normalizes German characters according to the heuristics of the German2 snowball algorithm. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.HindiNormalization"> <summary> Normalizes text in Hindi to remove some differences in spelling variations. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.IndicNormalization"> <summary> Normalizes the Unicode representation of text in Indian languages. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.KeywordRepeat"> <summary> Emits each incoming token twice, once as keyword and once as non-keyword. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.KStem"> <summary> A high-performance kstem filter for English. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Length"> <summary> Removes words that are too long or too short. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Limit"> <summary> Limits the number of tokens while indexing. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Lowercase"> <summary> Normalizes token text to lower case. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.NGram"> <summary> Generates n-grams of the given size(s). <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.PersianNormalization"> <summary> Applies normalization for Persian. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Phonetic"> <summary> Create tokens for phonetic matches. <see href="https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.PorterStem"> <summary> Uses the Porter stemming algorithm to transform the token stream. <see href="http://tartarus.org/~martin/PorterStemmer/" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Reverse"> <summary> Reverses the token string. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.ScandinavianNormalization"> <summary> Normalizes use of the interchangeable Scandinavian characters. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.ScandinavianFoldingNormalization"> <summary> Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Shingle"> <summary> Creates combinations of tokens as a single token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Snowball"> <summary> A filter that stems words using a Snowball-generated stemmer. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.SoraniNormalization"> <summary> Normalizes the Unicode representation of Sorani text. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Stemmer"> <summary> Language specific stemming filter. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Stopwords"> <summary> Removes stop words from a token stream. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Trim"> <summary> Trims leading and trailing whitespace from tokens. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Truncate"> <summary> Truncates the terms to a specific length. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Unique"> <summary> Filters out tokens with same text as the previous token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.Uppercase"> <summary> Normalizes token text to upper case. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenFilterName.WordDelimiter"> <summary> Splits words into subwords and performs optional transformations on subword groups. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenFilterName.Create(System.String)"> <summary> Creates a new TokenFilterName instance, or returns an existing instance if the given name matches that of a known token filter. </summary> <param name="name">Name of the token filter.</param> <returns>A TokenFilterName instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.TokenFilterName.op_Implicit(System.String)~Microsoft.Azure.Search.Models.TokenFilterName"> <summary> Defines implicit conversion from string to TokenFilterName. </summary> <param name="name">string to convert.</param> <returns>The string as a TokenFilterName.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.TokenizerName"> <summary> Defines the names of all tokenizers supported by Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Classic"> <summary> Grammar-based tokenizer that is suitable for processing most European-language documents. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.EdgeNGram"> <summary> Tokenizes the input from an edge into n-grams of the given size(s). <see href="https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Keyword"> <summary> Emits the entire input as a single token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Letter"> <summary> Divides text at non-letters. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Lowercase"> <summary> Divides text at non-letters and converts them to lower case. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.MicrosoftLanguageTokenizer"> <summary> Divides text using language-specific rules. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.MicrosoftLanguageStemmingTokenizer"> <summary> Divides text using language-specific rules and reduces words to their base forms. </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.NGram"> <summary> Tokenizes the input into n-grams of the given size(s). <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.PathHierarchy"> <summary> Tokenizer for path-like hierarchies. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Pattern"> <summary> Tokenizer that uses regex pattern matching to construct distinct tokens. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Standard"> <summary> Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.UaxUrlEmail"> <summary> Tokenizes urls and emails as one token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" /> </summary> </member> <member name="F:Microsoft.Azure.Search.Models.TokenizerName.Whitespace"> <summary> Divides text at whitespace. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenizerName.Create(System.String)"> <summary> Creates a new TokenizerName instance, or returns an existing instance if the given name matches that of a known tokenizer. </summary> <param name="name">Name of the tokenizer.</param> <returns>A TokenizerName instance with the given name.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.TokenizerName.op_Implicit(System.String)~Microsoft.Azure.Search.Models.TokenizerName"> <summary> Defines implicit conversion from string to TokenizerName. </summary> <param name="name">string to convert.</param> <returns>The string as a TokenizerName.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.AccessCondition"> <summary> Additional parameters for a set of operations. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.IfNotChanged(Microsoft.Azure.Search.Models.IResourceWithETag)"> <summary> Constructs an access condition such that an operation will be performed only if the resource's current ETag value matches the specified resource's ETag value. </summary> <param name="resource">A resource with an ETag value to check against the resource's ETag.</param> <returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-Match condition.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateEmptyCondition"> <summary> Constructs an empty access condition. </summary> <returns>An empty <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfExistsCondition"> <summary> Constructs an access condition such that an operation will be performed only if the resource exists. </summary> <returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents a condition where a resource exists.</returns> <remarks>Setting this access condition modifies the request to include the HTTP <i>If-Match</i> conditional header set to <c>"*"</c>.</remarks> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfMatchCondition(System.String)"> <summary> Constructs an access condition such that an operation will be performed only if the resource's current ETag value matches the specified ETag value. </summary> <param name="eTag">The ETag value to check against the resource's ETag.</param> <returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-Match condition.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNotExistsCondition"> <summary> Constructs an access condition such that an operation will be performed only if the resource does not exist. </summary> <returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents a condition where a resource does not exist.</returns> <remarks>Setting this access condition modifies the request to include the HTTP <i>If-None-Match</i> conditional header set to <c>"*"</c>.</remarks> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNoneMatchCondition(System.String)"> <summary> Constructs an access condition such that an operation will be performed only if the resource's current ETag value does not match the specified ETag value. </summary> <param name="eTag">The ETag value to check against the resource's ETag.</param> <returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-None-Match condition.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.#ctor"> <summary> Initializes a new instance of the AccessCondition class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AccessCondition.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the AccessCondition class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AccessCondition.IfMatch"> <summary> Gets or sets defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AccessCondition.IfNoneMatch"> <summary> Gets or sets defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ExtensibleEnum`1"> <summary> Abstract base class for types that act like enums, but can be extended with arbitrary string values. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.#ctor(System.String)"> <summary> Initializes a new instance of the ExtensibleEnum class. </summary> <param name="name">The value for this instance of the extensible enumeration.</param> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.op_Equality(Microsoft.Azure.Search.Models.ExtensibleEnum{`0},`0)"> <summary> Compares two ExtensibleEnum values for equality. </summary> <param name="lhs">The first ExtensibleEnum to compare.</param> <param name="rhs">The second ExtensibleEnum to compare.</param> <returns>true if the ExtensibleEnum objects are equal or are both null; false otherwise.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.op_Inequality(Microsoft.Azure.Search.Models.ExtensibleEnum{`0},`0)"> <summary> Compares two ExtensibleEnum values for inequality. </summary> <param name="lhs">The first ExtensibleEnum to compare.</param> <param name="rhs">The second ExtensibleEnum to compare.</param> <returns>true if the ExtensibleEnum objects are not equal; false otherwise.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.op_Explicit(Microsoft.Azure.Search.Models.ExtensibleEnum{`0})~System.String"> <summary> Defines explicit conversion from ExtensibleEnum to string. </summary> <param name="name">ExtensibleEnum to convert.</param> <returns>The ExtensibleEnum as a string.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.Lookup(System.String)"> <summary> Looks up an ExtensibleEnum instance by name, or returns null if the given name does not match one of the known values of this ExtensibleEnum. </summary> <param name="name">Name of the ExtensibleEnum value.</param> <returns>An instance of type T with the given name, or null if no such instance could be found.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.Equals(`0)"> <summary> Compares the ExtensibleEnum for equality with another ExtensibleEnum. </summary> <param name="other">The ExtensibleEnum with which to compare.</param> <returns>true if the ExtensibleEnum objects are equal; false otherwise.</returns> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.Equals(System.Object)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.GetHashCode"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.Models.ExtensibleEnum`1.ToString"> <summary> Returns a string representation of the ExtensibleEnum. </summary> <returns>The ExtensibleEnum as a string.</returns> </member> <member name="T:Microsoft.Azure.Search.Models.IResourceWithETag"> <summary> Model classes that implement this interface represent resources that are persisted with an ETag version on the server. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IResourceWithETag.ETag"> <summary> Gets the ETag value for the resource. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DocumentIndexResult"> <summary> Response containing the status of operations for all documents in the indexing request. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DocumentIndexResult.#ctor"> <summary> Initializes a new instance of the DocumentIndexResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DocumentIndexResult.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.IndexingResult})"> <summary> Initializes a new instance of the DocumentIndexResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DocumentIndexResult.Results"> <summary> Gets the list of status information for each document in the indexing request. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexActionType"> <summary> Defines values for IndexActionType. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.QueryType"> <summary> Defines values for QueryType. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SearchMode"> <summary> Defines values for SearchMode. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SearchParametersPayload"> <summary> Parameters for filtering, sorting, faceting, paging, and other search query behaviors. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchParametersPayload.#ctor"> <summary> Initializes a new instance of the SearchParametersPayload class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchParametersPayload.#ctor(System.Nullable{System.Boolean},System.Collections.Generic.IList{System.String},System.String,System.String,System.String,System.String,System.Nullable{System.Double},System.String,System.Nullable{Microsoft.Azure.Search.Models.QueryType},System.Collections.Generic.IList{System.String},System.String,System.String,System.String,System.Nullable{Microsoft.Azure.Search.Models.SearchMode},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the SearchParametersPayload class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Count"> <summary> Gets or sets a value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Facets"> <summary> Gets or sets the list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Filter"> <summary> Gets or sets the OData $filter expression to apply to the search query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Highlight"> <summary> Gets or sets the comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.HighlightPostTag"> <summary> Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. Default is &lt;/em&gt;. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.HighlightPreTag"> <summary> Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. Default is &lt;em&gt;. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.MinimumCoverage"> <summary> Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.OrderBy"> <summary> Gets or sets the comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.QueryType"> <summary> Gets or sets gets or sets a value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. Possible values include: 'simple', 'full' </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.ScoringParameters"> <summary> Gets or sets the list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name:value. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation:-122.2,44.8"(without the quotes). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.ScoringProfile"> <summary> Gets or sets the name of a scoring profile to evaluate match scores for matching documents in order to sort the results. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Search"> <summary> Gets or sets a full-text search query expression; Use null or "*" to match all documents. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.SearchFields"> <summary> Gets or sets the comma-separated list of field names to include in the full-text search. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.SearchMode"> <summary> Gets or sets a value that specifies whether any or all of the search terms must be matched in order to count the document as a match. Possible values include: 'any', 'all' </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Select"> <summary> Gets or sets the comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Skip"> <summary> Gets or sets the number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using OrderBy on a totally-ordered key and Filter with a range query instead. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchParametersPayload.Top"> <summary> Gets or sets the number of search results to retrieve. This can be used in conjunction with Skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be passed to ContinueSearch to retrieve the next page of results. See DocumentSearchResponse.ContinuationToken for more information. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SuggestParametersPayload"> <summary> Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestParametersPayload.#ctor"> <summary> Initializes a new instance of the SuggestParametersPayload class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SuggestParametersPayload.#ctor(System.String,System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Double},System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the SuggestParametersPayload class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.Filter"> <summary> Gets or sets the OData $filter expression to apply to the suggestions query. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.Fuzzy"> <summary> Gets or sets a value indicating whether to use fuzzy matching for the suggestion query. Default is false. when set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.HighlightPostTag"> <summary> Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting of suggestions is disabled. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.HighlightPreTag"> <summary> Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting of suggestions is disabled. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.MinimumCoverage"> <summary> Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.OrderBy"> <summary> Gets or sets the comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.Search"> <summary> Gets or sets the search text on which to base suggestions. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.SearchFields"> <summary> Gets or sets the comma-separated list of field names to consider when querying for suggestions. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.Select"> <summary> Gets or sets the comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.SuggesterName"> <summary> Gets or sets the name of the suggester as specified in the suggesters collection that's part of the index definition. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SuggestParametersPayload.Top"> <summary> Gets or sets the number of suggestions to retrieve. This must be a value between 1 and 100. The default is to 5. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.Analyzer"> <summary> Abstract base class for analyzers. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Analyzer.#ctor"> <summary> Initializes a new instance of the Analyzer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Analyzer.#ctor(System.String)"> <summary> Initializes a new instance of the Analyzer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Analyzer.Name"> <summary> Gets or sets the name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Analyzer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.AnalyzeRequest"> <summary> Specifies some text and analysis components used to break that text into tokens. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzeRequest.#ctor"> <summary> Initializes a new instance of the AnalyzeRequest class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzeRequest.#ctor(System.String,Microsoft.Azure.Search.Models.AnalyzerName,Microsoft.Azure.Search.Models.TokenizerName,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenFilterName},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.CharFilterName})"> <summary> Initializes a new instance of the AnalyzeRequest class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Text"> <summary> Gets or sets the text to break into tokens. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Analyzer"> <summary> Gets or sets the name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Tokenizer"> <summary> Gets or sets the name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeRequest.TokenFilters"> <summary> Gets or sets an optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeRequest.CharFilters"> <summary> Gets or sets an optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzeRequest.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.AnalyzeResult"> <summary> The result of testing an analyzer on text. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzeResult.#ctor"> <summary> Initializes a new instance of the AnalyzeResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AnalyzeResult.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenInfo})"> <summary> Initializes a new instance of the AnalyzeResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AnalyzeResult.Tokens"> <summary> Gets or sets the list of tokens returned by the analyzer specified in the request. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.AsciiFoldingTokenFilter"> <summary> Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AsciiFoldingTokenFilter.#ctor"> <summary> Initializes a new instance of the AsciiFoldingTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AsciiFoldingTokenFilter.#ctor(System.String,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the AsciiFoldingTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.AsciiFoldingTokenFilter.PreserveOriginal"> <summary> Gets or sets a value indicating whether the original token will be kept. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.AsciiFoldingTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.CharFilter"> <summary> Abstract base class for character filters. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CharFilter.#ctor"> <summary> Initializes a new instance of the CharFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CharFilter.#ctor(System.String)"> <summary> Initializes a new instance of the CharFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CharFilter.Name"> <summary> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CharFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.CjkBigramTokenFilterScripts"> <summary> Defines values for CjkBigramTokenFilterScripts. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ClassicTokenizer"> <summary> Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ClassicTokenizer.#ctor"> <summary> Initializes a new instance of the ClassicTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ClassicTokenizer.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the ClassicTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ClassicTokenizer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ClassicTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.CommonGramTokenFilter"> <summary> Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CommonGramTokenFilter.#ctor"> <summary> Initializes a new instance of the CommonGramTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CommonGramTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the CommonGramTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.CommonWords"> <summary> Gets or sets the set of common words. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.IgnoreCase"> <summary> Gets or sets a value indicating whether common words matching will be case insensitive. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.UseQueryMode"> <summary> Gets or sets a value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CommonGramTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.CorsOptions"> <summary> Defines options to control Cross-Origin Resource Sharing (CORS) for an index. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CorsOptions.#ctor"> <summary> Initializes a new instance of the CorsOptions class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CorsOptions.#ctor(System.Collections.Generic.IList{System.String},System.Nullable{System.Int64})"> <summary> Initializes a new instance of the CorsOptions class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CorsOptions.AllowedOrigins"> <summary> Gets or sets the list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CorsOptions.MaxAgeInSeconds"> <summary> Gets or sets the duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CorsOptions.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.CustomAnalyzer"> <summary> Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CustomAnalyzer.#ctor"> <summary> Initializes a new instance of the CustomAnalyzer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CustomAnalyzer.#ctor(System.String,Microsoft.Azure.Search.Models.TokenizerName,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenFilterName},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.CharFilterName})"> <summary> Initializes a new instance of the CustomAnalyzer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CustomAnalyzer.Tokenizer"> <summary> Gets or sets the name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CustomAnalyzer.TokenFilters"> <summary> Gets or sets a list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.CustomAnalyzer.CharFilters"> <summary> Gets or sets a list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.CustomAnalyzer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DataChangeDetectionPolicy"> <summary> Abstract base class for data change detection policies. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataChangeDetectionPolicy.#ctor"> <summary> Initializes a new instance of the DataChangeDetectionPolicy class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DataContainer"> <summary> Represents information about the entity (such as Azure SQL table or DocumentDb collection) that will be indexed. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataContainer.#ctor"> <summary> Initializes a new instance of the DataContainer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataContainer.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the DataContainer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataContainer.Name"> <summary> Gets or sets the name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataContainer.Query"> <summary> Gets or sets a query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataContainer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy"> <summary> Abstract base class for data deletion detection policies. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy.#ctor"> <summary> Initializes a new instance of the DataDeletionDetectionPolicy class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DataSourceCredentials"> <summary> Represents credentials that can be used to connect to a datasource. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceCredentials.#ctor"> <summary> Initializes a new instance of the DataSourceCredentials class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceCredentials.#ctor(System.String)"> <summary> Initializes a new instance of the DataSourceCredentials class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSourceCredentials.ConnectionString"> <summary> Gets or sets the connection string for the datasource. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceCredentials.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DataSourceListResult"> <summary> Response from a List Datasources request. If successful, it includes the full definitions of all datasources. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceListResult.#ctor"> <summary> Initializes a new instance of the DataSourceListResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DataSourceListResult.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.DataSource})"> <summary> Initializes a new instance of the DataSourceListResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DataSourceListResult.DataSources"> <summary> Gets the datasources in the Search service. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter"> <summary> Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.#ctor"> <summary> Initializes a new instance of the DictionaryDecompounderTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the DictionaryDecompounderTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.WordList"> <summary> Gets or sets the list of words to match against. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinWordSize"> <summary> Gets or sets the minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinSubwordSize"> <summary> Gets or sets the minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MaxSubwordSize"> <summary> Gets or sets the maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.OnlyLongestMatch"> <summary> Gets or sets a value indicating whether to add only the longest matching subword to the output. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.DistanceScoringParameters"> <summary> Provides parameter values to a distance scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringParameters.#ctor"> <summary> Initializes a new instance of the DistanceScoringParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringParameters.#ctor(System.String,System.Double)"> <summary> Initializes a new instance of the DistanceScoringParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DistanceScoringParameters.ReferencePointParameter"> <summary> Gets or sets the name of the parameter passed in search queries to specify the reference location. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.DistanceScoringParameters.BoostingDistance"> <summary> Gets or sets the distance in kilometers from the reference location where the boosting range ends. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.DistanceScoringParameters.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide"> <summary> Defines values for EdgeNGramTokenFilterSide. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2"> <summary> Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.#ctor"> <summary> Initializes a new instance of the EdgeNGramTokenFilterV2 class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide})"> <summary> Initializes a new instance of the EdgeNGramTokenFilterV2 class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. Maximum is 300. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.Side"> <summary> Gets or sets specifies which side of the input the n-gram should be generated from. Default is "front". Possible values include: 'front', 'back' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.ElisionTokenFilter"> <summary> Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ElisionTokenFilter.#ctor"> <summary> Initializes a new instance of the ElisionTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ElisionTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the ElisionTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ElisionTokenFilter.Articles"> <summary> Gets or sets the set of articles to remove. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ElisionTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.FreshnessScoringParameters"> <summary> Provides parameter values to a freshness scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringParameters.#ctor"> <summary> Initializes a new instance of the FreshnessScoringParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringParameters.#ctor(System.TimeSpan)"> <summary> Initializes a new instance of the FreshnessScoringParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.FreshnessScoringParameters.BoostingDuration"> <summary> Gets or sets the expiration period after which boosting will stop for a particular document. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.FreshnessScoringParameters.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy"> <summary> Defines a data change detection policy that captures changes based on the value of a high water mark column. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy.#ctor"> <summary> Initializes a new instance of the HighWaterMarkChangeDetectionPolicy class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy.#ctor(System.String)"> <summary> Initializes a new instance of the HighWaterMarkChangeDetectionPolicy class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy.HighWaterMarkColumnName"> <summary> Gets or sets the name of the high water mark column. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.HighWaterMarkChangeDetectionPolicy.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.IndexerExecutionStatus"> <summary> Defines values for IndexerExecutionStatus. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexerListResult"> <summary> Response from a List Indexers request. If successful, it includes the full definitions of all indexers. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerListResult.#ctor"> <summary> Initializes a new instance of the IndexerListResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexerListResult.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Indexer})"> <summary> Initializes a new instance of the IndexerListResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexerListResult.Indexers"> <summary> Gets the indexers in the Search service. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexerStatus"> <summary> Defines values for IndexerStatus. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.IndexingSchedule"> <summary> Represents a schedule for indexer execution. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingSchedule.#ctor"> <summary> Initializes a new instance of the IndexingSchedule class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingSchedule.#ctor(System.TimeSpan,System.Nullable{System.DateTimeOffset})"> <summary> Initializes a new instance of the IndexingSchedule class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingSchedule.Interval"> <summary> Gets or sets the interval of time between indexer executions. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexingSchedule.StartTime"> <summary> Gets or sets the time when an indexer should start running. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexingSchedule.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.IndexListResult"> <summary> Response from a List Indexes request. If successful, it includes the full definitions of all indexes. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexListResult.#ctor"> <summary> Initializes a new instance of the IndexListResult class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.IndexListResult.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Index})"> <summary> Initializes a new instance of the IndexListResult class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.IndexListResult.Indexes"> <summary> Gets the indexes in the Search service. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ItemError"> <summary> Represents an item- or document-level indexing error. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ItemError.#ctor"> <summary> Initializes a new instance of the ItemError class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ItemError.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the ItemError class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ItemError.Key"> <summary> Gets the key of the item for which indexing failed. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ItemError.ErrorMessage"> <summary> Gets the message describing the error that occurred while attempting to index the item. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.KeepTokenFilter"> <summary> A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeepTokenFilter.#ctor"> <summary> Initializes a new instance of the KeepTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeepTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the KeepTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeepTokenFilter.KeepWords"> <summary> Gets or sets the list of words to keep. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeepTokenFilter.LowerCaseKeepWords"> <summary> Gets or sets a value indicating whether to lower case all words first. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeepTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter"> <summary> Marks terms as keywords. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter.#ctor"> <summary> Initializes a new instance of the KeywordMarkerTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the KeywordMarkerTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter.Keywords"> <summary> Gets or sets a list of words to mark as keywords. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter.IgnoreCase"> <summary> Gets or sets a value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordMarkerTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.KeywordTokenizerV2"> <summary> Emits the entire input as a single token. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizerV2.#ctor"> <summary> Initializes a new instance of the KeywordTokenizerV2 class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizerV2.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the KeywordTokenizerV2 class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.KeywordTokenizerV2.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.KeywordTokenizerV2.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.LengthTokenFilter"> <summary> Removes words that are too long or too short. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LengthTokenFilter.#ctor"> <summary> Initializes a new instance of the LengthTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LengthTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the LengthTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.LengthTokenFilter.Min"> <summary> Gets or sets the minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.LengthTokenFilter.Max"> <summary> Gets or sets the maximum length in characters. Default and maximum is 300. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LengthTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.LimitTokenFilter"> <summary> Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LimitTokenFilter.#ctor"> <summary> Initializes a new instance of the LimitTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LimitTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the LimitTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.LimitTokenFilter.MaxTokenCount"> <summary> Gets or sets the maximum number of tokens to produce. Default is 1. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.LimitTokenFilter.ConsumeAllTokens"> <summary> Gets or sets a value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.LimitTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.MagnitudeScoringParameters"> <summary> Provides parameter values to a magnitude scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.#ctor"> <summary> Initializes a new instance of the MagnitudeScoringParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.#ctor(System.Double,System.Double,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the MagnitudeScoringParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.BoostingRangeStart"> <summary> Gets or sets the field value at which boosting starts. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.BoostingRangeEnd"> <summary> Gets or sets the field value at which boosting ends. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.ShouldBoostBeyondRangeByConstant"> <summary> Gets or sets a value indicating whether to apply a constant boost for field values beyond the range end value; default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.MappingCharFilter"> <summary> A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene. <see href="https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MappingCharFilter.#ctor"> <summary> Initializes a new instance of the MappingCharFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MappingCharFilter.#ctor(System.String,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the MappingCharFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MappingCharFilter.Mappings"> <summary> Gets or sets a list of mappings of the following format: "a=>b" (all occurrences of the character "a" will be replaced with character "b"). </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MappingCharFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer"> <summary> Divides text using language-specific rules and reduces words to their base forms. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.#ctor"> <summary> Initializes a new instance of the MicrosoftLanguageStemmingTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.Search.Models.MicrosoftStemmingTokenizerLanguage})"> <summary> Initializes a new instance of the MicrosoftLanguageStemmingTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.IsSearchTokenizer"> <summary> Gets or sets a value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.Language"> <summary> Gets or sets the language to use. The default is English. Possible values include: 'arabic', 'bangla', 'bulgarian', 'catalan', 'croatian', 'czech', 'danish', 'dutch', 'english', 'estonian', 'finnish', 'french', 'german', 'greek', 'gujarati', 'hebrew', 'hindi', 'hungarian', 'icelandic', 'indonesian', 'italian', 'kannada', 'latvian', 'lithuanian', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish', 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian', 'serbianCyrillic', 'serbianLatin', 'slovak', 'slovenian', 'spanish', 'swedish', 'tamil', 'telugu', 'turkish', 'ukrainian', 'urdu' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageStemmingTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer"> <summary> Divides text using language-specific rules. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.#ctor"> <summary> Initializes a new instance of the MicrosoftLanguageTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.Search.Models.MicrosoftTokenizerLanguage})"> <summary> Initializes a new instance of the MicrosoftLanguageTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.IsSearchTokenizer"> <summary> Gets or sets a value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.Language"> <summary> Gets or sets the language to use. The default is English. Possible values include: 'bangla', 'bulgarian', 'catalan', 'chineseSimplified', 'chineseTraditional', 'croatian', 'czech', 'danish', 'dutch', 'english', 'french', 'german', 'greek', 'gujarati', 'hindi', 'icelandic', 'indonesian', 'italian', 'japanese', 'kannada', 'korean', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish', 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian', 'serbianCyrillic', 'serbianLatin', 'slovenian', 'spanish', 'swedish', 'tamil', 'telugu', 'thai', 'ukrainian', 'urdu', 'vietnamese' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.MicrosoftLanguageTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.MicrosoftStemmingTokenizerLanguage"> <summary> Defines values for MicrosoftStemmingTokenizerLanguage. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.MicrosoftTokenizerLanguage"> <summary> Defines values for MicrosoftTokenizerLanguage. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.NGramTokenFilterV2"> <summary> Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilterV2.#ctor"> <summary> Initializes a new instance of the NGramTokenFilterV2 class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilterV2.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the NGramTokenFilterV2 class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenFilterV2.MinGram"> <summary> Gets or sets the minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.NGramTokenFilterV2.MaxGram"> <summary> Gets or sets the maximum n-gram length. Default is 2. Maximum is 300. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.NGramTokenFilterV2.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PatternAnalyzer"> <summary> Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternAnalyzer.#ctor"> <summary> Initializes a new instance of the PatternAnalyzer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternAnalyzer.#ctor(System.String,System.Nullable{System.Boolean},System.String,Microsoft.Azure.Search.Models.RegexFlags,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the PatternAnalyzer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternAnalyzer.LowerCaseTerms"> <summary> Gets or sets a value indicating whether terms should be lower-cased. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternAnalyzer.Pattern"> <summary> Gets or sets a regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternAnalyzer.Flags"> <summary> Gets or sets regular expression flags. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternAnalyzer.Stopwords"> <summary> Gets or sets a list of stopwords. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternAnalyzer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter"> <summary> Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter.#ctor"> <summary> Initializes a new instance of the PatternCaptureTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the PatternCaptureTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter.Patterns"> <summary> Gets or sets a list of patterns to match against each token. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter.PreserveOriginal"> <summary> Gets or sets a value indicating whether to return the original token even if one of the patterns matches. Default is true. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternCaptureTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PatternReplaceCharFilter"> <summary> A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This character filter is implemented using Apache Lucene. <see href="https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.#ctor"> <summary> Initializes a new instance of the PatternReplaceCharFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.#ctor(System.String,System.String,System.String)"> <summary> Initializes a new instance of the PatternReplaceCharFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Pattern"> <summary> Gets or sets a regular expression pattern. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Replacement"> <summary> Gets or sets the replacement text. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter"> <summary> A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter.#ctor"> <summary> Initializes a new instance of the PatternReplaceTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter.#ctor(System.String,System.String,System.String)"> <summary> Initializes a new instance of the PatternReplaceTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter.Pattern"> <summary> Gets or sets a regular expression pattern. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter.Replacement"> <summary> Gets or sets the replacement text. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternReplaceTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PatternTokenizer"> <summary> Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternTokenizer.#ctor"> <summary> Initializes a new instance of the PatternTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternTokenizer.#ctor(System.String,System.String,Microsoft.Azure.Search.Models.RegexFlags,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the PatternTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternTokenizer.Pattern"> <summary> Gets or sets a regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternTokenizer.Flags"> <summary> Gets or sets regular expression flags. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PatternTokenizer.Group"> <summary> Gets or sets the zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PatternTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.PhoneticEncoder"> <summary> Defines values for PhoneticEncoder. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.PhoneticTokenFilter"> <summary> Create tokens for phonetic matches. This token filter is implemented using Apache Lucene. <see href="https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PhoneticTokenFilter.#ctor"> <summary> Initializes a new instance of the PhoneticTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PhoneticTokenFilter.#ctor(System.String,System.Nullable{Microsoft.Azure.Search.Models.PhoneticEncoder},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the PhoneticTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PhoneticTokenFilter.Encoder"> <summary> Gets or sets the phonetic encoder to use. Default is "metaphone". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse' </summary> </member> <member name="P:Microsoft.Azure.Search.Models.PhoneticTokenFilter.ReplaceOriginalTokens"> <summary> Gets or sets a value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.PhoneticTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.ScoringFunction"> <summary> Abstract base class for functions that can modify document scores during ranking. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringFunction.#ctor"> <summary> Initializes a new instance of the ScoringFunction class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringFunction.#ctor(System.String,System.Double,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})"> <summary> Initializes a new instance of the ScoringFunction class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringFunction.FieldName"> <summary> Gets or sets the name of the field used as input to the scoring function. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringFunction.Boost"> <summary> Gets or sets a multiplier for the raw score. Must be a positive number not equal to 1.0. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringFunction.Interpolation"> <summary> Gets or sets a value indicating how boosting will be interpolated across document scores; defaults to "Linear". Possible values include: 'linear', 'constant', 'quadratic', 'logarithmic' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringFunction.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.ScoringFunctionAggregation"> <summary> Defines values for ScoringFunctionAggregation. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ScoringFunctionInterpolation"> <summary> Defines values for ScoringFunctionInterpolation. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ScoringProfile"> <summary> Defines parameters for an Azure Search index that influence scoring in search queries. <see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringProfile.#ctor"> <summary> Initializes a new instance of the ScoringProfile class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringProfile.#ctor(System.String,Microsoft.Azure.Search.Models.TextWeights,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.ScoringFunction},System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionAggregation})"> <summary> Initializes a new instance of the ScoringProfile class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringProfile.Name"> <summary> Gets or sets the name of the scoring profile. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringProfile.TextWeights"> <summary> Gets or sets parameters that boost scoring based on text matches in certain index fields. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringProfile.Functions"> <summary> Gets or sets the collection of functions that influence the scoring of documents. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ScoringProfile.FunctionAggregation"> <summary> Gets or sets a value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ScoringProfile.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.SearchRequestOptions"> <summary> Additional parameters for a set of operations. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchRequestOptions.#ctor"> <summary> Initializes a new instance of the SearchRequestOptions class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SearchRequestOptions.#ctor(System.Nullable{System.Guid})"> <summary> Initializes a new instance of the SearchRequestOptions class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SearchRequestOptions.ClientRequestId"> <summary> Gets or sets the tracking ID sent with the request to help with debugging. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.ShingleTokenFilter"> <summary> Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ShingleTokenFilter.#ctor"> <summary> Initializes a new instance of the ShingleTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ShingleTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.String)"> <summary> Initializes a new instance of the ShingleTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.MaxShingleSize"> <summary> Gets or sets the maximum shingle size. Default and minimum value is 2. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.MinShingleSize"> <summary> Gets or sets the minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigrams"> <summary> Gets or sets a value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigramsIfNoShingles"> <summary> Gets or sets a value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.TokenSeparator"> <summary> Gets or sets the string to use when joining adjacent tokens to form a shingle. Default is a single space (" "). </summary> </member> <member name="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.FilterToken"> <summary> Gets or sets the string to insert for each position at which there is no token. Default is an underscore ("_"). </summary> </member> <member name="M:Microsoft.Azure.Search.Models.ShingleTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.SnowballTokenFilter"> <summary> A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SnowballTokenFilter.#ctor"> <summary> Initializes a new instance of the SnowballTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SnowballTokenFilter.#ctor(System.String,Microsoft.Azure.Search.Models.SnowballTokenFilterLanguage)"> <summary> Initializes a new instance of the SnowballTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SnowballTokenFilter.Language"> <summary> Gets or sets the language to use. Possible values include: 'armenian', 'basque', 'catalan', 'danish', 'dutch', 'english', 'finnish', 'french', 'german', 'german2', 'hungarian', 'italian', 'kp', 'lovins', 'norwegian', 'porter', 'portuguese', 'romanian', 'russian', 'spanish', 'swedish', 'turkish' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SnowballTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.SnowballTokenFilterLanguage"> <summary> Defines values for SnowballTokenFilterLanguage. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SqlIntegratedChangeTrackingPolicy"> <summary> Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SqlIntegratedChangeTrackingPolicy.#ctor"> <summary> Initializes a new instance of the SqlIntegratedChangeTrackingPolicy class. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.StandardAnalyzer"> <summary> Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardAnalyzer.#ctor"> <summary> Initializes a new instance of the StandardAnalyzer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardAnalyzer.#ctor(System.String,System.Nullable{System.Int32},System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the StandardAnalyzer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StandardAnalyzer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StandardAnalyzer.Stopwords"> <summary> Gets or sets a list of stopwords. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardAnalyzer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.StandardTokenizerV2"> <summary> Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizerV2.#ctor"> <summary> Initializes a new instance of the StandardTokenizerV2 class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizerV2.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the StandardTokenizerV2 class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StandardTokenizerV2.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StandardTokenizerV2.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.StemmerOverrideTokenFilter"> <summary> Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerOverrideTokenFilter.#ctor"> <summary> Initializes a new instance of the StemmerOverrideTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerOverrideTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the StemmerOverrideTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StemmerOverrideTokenFilter.Rules"> <summary> Gets or sets a list of stemming rules in the following format: "word => stem", for example: "ran => run" </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerOverrideTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.StemmerTokenFilter"> <summary> Language specific stemming filter. This token filter is implemented using Apache Lucene. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerTokenFilter.#ctor"> <summary> Initializes a new instance of the StemmerTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerTokenFilter.#ctor(System.String,Microsoft.Azure.Search.Models.StemmerTokenFilterLanguage)"> <summary> Initializes a new instance of the StemmerTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StemmerTokenFilter.Language"> <summary> Gets or sets the language to use. Possible values include: 'arabic', 'armenian', 'basque', 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch', 'dutchKp', 'english', 'lightEnglish', 'minimalEnglish', 'possessiveEnglish', 'porter2', 'lovins', 'finnish', 'lightFinnish', 'french', 'lightFrench', 'minimalFrench', 'galician', 'minimalGalician', 'german', 'german2', 'lightGerman', 'minimalGerman', 'greek', 'hindi', 'hungarian', 'lightHungarian', 'indonesian', 'irish', 'italian', 'lightItalian', 'sorani', 'latvian', 'norwegian', 'lightNorwegian', 'minimalNorwegian', 'lightNynorsk', 'minimalNynorsk', 'portuguese', 'lightPortuguese', 'minimalPortuguese', 'portugueseRslp', 'romanian', 'russian', 'lightRussian', 'spanish', 'lightSpanish', 'swedish', 'lightSwedish', 'turkish' </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StemmerTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.StemmerTokenFilterLanguage"> <summary> Defines values for StemmerTokenFilterLanguage. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.StopAnalyzer"> <summary> Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopAnalyzer.#ctor"> <summary> Initializes a new instance of the StopAnalyzer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopAnalyzer.#ctor(System.String,System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the StopAnalyzer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StopAnalyzer.Stopwords"> <summary> Gets or sets a list of stopwords. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopAnalyzer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.StopwordsList"> <summary> Defines values for StopwordsList. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.StopwordsTokenFilter"> <summary> Removes stop words from a token stream. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopwordsTokenFilter.#ctor"> <summary> Initializes a new instance of the StopwordsTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopwordsTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{Microsoft.Azure.Search.Models.StopwordsList},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the StopwordsTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StopwordsTokenFilter.Stopwords"> <summary> Gets or sets the list of stopwords. This property and the stopwords list property cannot both be set. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StopwordsTokenFilter.StopwordsList"> <summary> Gets or sets a predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English. Possible values include: 'arabic', 'armenian', 'basque', 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch', 'english', 'finnish', 'french', 'galician', 'german', 'greek', 'hindi', 'hungarian', 'indonesian', 'irish', 'italian', 'latvian', 'norwegian', 'persian', 'portuguese', 'romanian', 'russian', 'sorani', 'spanish', 'swedish', 'thai', 'turkish' </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StopwordsTokenFilter.IgnoreCase"> <summary> Gets or sets a value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.StopwordsTokenFilter.RemoveTrailingStopWords"> <summary> Gets or sets a value indicating whether to ignore the last search term if it's a stop word. Default is true. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.StopwordsTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.SuggesterSearchMode"> <summary> Defines values for SuggesterSearchMode. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.SynonymTokenFilter"> <summary> Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SynonymTokenFilter.#ctor"> <summary> Initializes a new instance of the SynonymTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SynonymTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the SynonymTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SynonymTokenFilter.Synonyms"> <summary> Gets or sets a list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SynonymTokenFilter.IgnoreCase"> <summary> Gets or sets a value indicating whether to case-fold input for matching. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.SynonymTokenFilter.Expand"> <summary> Gets or sets a value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.SynonymTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TagScoringParameters"> <summary> Provides parameter values to a tag scoring function. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringParameters.#ctor"> <summary> Initializes a new instance of the TagScoringParameters class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringParameters.#ctor(System.String)"> <summary> Initializes a new instance of the TagScoringParameters class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TagScoringParameters.TagsParameter"> <summary> Gets or sets the name of the parameter passed in search queries to specify the list of tags to compare against the target field. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TagScoringParameters.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TokenCharacterKind"> <summary> Defines values for TokenCharacterKind. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.TokenFilter"> <summary> Abstract base class for token filters. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenFilter.#ctor"> <summary> Initializes a new instance of the TokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenFilter.#ctor(System.String)"> <summary> Initializes a new instance of the TokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TokenFilter.Name"> <summary> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TokenInfo"> <summary> Information about a token returned by an analyzer. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenInfo.#ctor"> <summary> Initializes a new instance of the TokenInfo class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TokenInfo.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Initializes a new instance of the TokenInfo class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TokenInfo.Token"> <summary> Gets the token returned by the analyzer. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TokenInfo.StartOffset"> <summary> Gets the index of the first character of the token in the input text. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TokenInfo.EndOffset"> <summary> Gets the index of the last character of the token in the input text. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TokenInfo.Position"> <summary> Gets the position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. </summary> </member> <member name="T:Microsoft.Azure.Search.Models.Tokenizer"> <summary> Abstract base class for tokenizers. <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Tokenizer.#ctor"> <summary> Initializes a new instance of the Tokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Tokenizer.#ctor(System.String)"> <summary> Initializes a new instance of the Tokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.Tokenizer.Name"> <summary> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.Tokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.TruncateTokenFilter"> <summary> Truncates the terms to a specific length. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TruncateTokenFilter.#ctor"> <summary> Initializes a new instance of the TruncateTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TruncateTokenFilter.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the TruncateTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.TruncateTokenFilter.Length"> <summary> Gets or sets the length at which terms will be truncated. Default and maximum is 300. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.TruncateTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.UaxUrlEmailTokenizer"> <summary> Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UaxUrlEmailTokenizer.#ctor"> <summary> Initializes a new instance of the UaxUrlEmailTokenizer class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UaxUrlEmailTokenizer.#ctor(System.String,System.Nullable{System.Int32})"> <summary> Initializes a new instance of the UaxUrlEmailTokenizer class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.UaxUrlEmailTokenizer.MaxTokenLength"> <summary> Gets or sets the maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UaxUrlEmailTokenizer.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.UniqueTokenFilter"> <summary> Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UniqueTokenFilter.#ctor"> <summary> Initializes a new instance of the UniqueTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UniqueTokenFilter.#ctor(System.String,System.Nullable{System.Boolean})"> <summary> Initializes a new instance of the UniqueTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.UniqueTokenFilter.OnlyOnSamePosition"> <summary> Gets or sets a value indicating whether to remove duplicates only at the same position. Default is false. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.UniqueTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="T:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter"> <summary> Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" /> </summary> </member> <member name="M:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.#ctor"> <summary> Initializes a new instance of the WordDelimiterTokenFilter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.#ctor(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Collections.Generic.IList{System.String})"> <summary> Initializes a new instance of the WordDelimiterTokenFilter class. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.GenerateWordParts"> <summary> Gets or sets a value indicating whether to generate part words. If set, causes parts of words to be generated; for example "AzureSearch" becomes "Azure" "Search". Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.GenerateNumberParts"> <summary> Gets or sets a value indicating whether to generate number subwords. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.CatenateWords"> <summary> Gets or sets a value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.CatenateNumbers"> <summary> Gets or sets a value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, "1-2" becomes "12". Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.CatenateAll"> <summary> Gets or sets a value indicating whether all subword parts will be catenated. For example, if this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.SplitOnCaseChange"> <summary> Gets or sets a value indicating whether to split words on caseChange. For example, if this is set to true, "AzureSearch" becomes "Azure" "Search". Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.PreserveOriginal"> <summary> Gets or sets a value indicating whether original words will be preserved and added to the subword list. Default is false. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.SplitOnNumerics"> <summary> Gets or sets a value indicating whether to split on numbers. For example, if this is set to true, "Azure1Search" becomes "Azure" "1" "Search". Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.StemEnglishPossessive"> <summary> Gets or sets a value indicating whether to remove trailing "'s" for each subword. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.ProtectedWords"> <summary> Gets or sets a list of tokens to protect from being delimited. </summary> </member> <member name="M:Microsoft.Azure.Search.Models.WordDelimiterTokenFilter.Validate"> <summary> Validate the object. </summary> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown if validation fails </exception> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperations.#ctor(Microsoft.Azure.Search.SearchIndexClient)"> <summary> Initializes a new instance of the DocumentsOperations class. </summary> <param name='client'> Reference to the service client. </param> </member> <member name="P:Microsoft.Azure.Search.DocumentsOperations.Client"> <summary> Gets a reference to the SearchIndexClient </summary> </member> <member name="T:Microsoft.Azure.Search.DocumentsOperationsExtensions"> <summary> Operations for querying an index and uploading, merging, and deleting documents. <see href="https://docs.microsoft.com/rest/api/searchservice/Document-operations" /> </summary> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Count(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Queries the number of documents in the Azure Search index. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.CountAsync(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Queries the number of documents in the Azure Search index. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.ContinueSearch(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.ContinueSearchAsync(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.ContinueSearch``1(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.ContinueSearchAsync``1(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Get(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. All retrievable fields are included in the result by default. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> The requested document. </returns> <remarks> The non-generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.GetAsync(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> The requested document. </returns> <remarks> The non-generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Get``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will have null or default as its corresponding property value in the returned object. All retrievable fields are included in the result by default. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> The requested document. </returns> <remarks> The generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.GetAsync``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will have null or default as its corresponding property value in the returned object. All retrievable fields are included in the result by default. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> The requested document. </returns> <remarks> The generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Index(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.IndexBatch,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <remarks> The non-generic overloads of the Index, IndexAsync, and IndexWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> <returns> Response containing the status of operations for all actions in the batch. </returns> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.IndexAsync(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.IndexBatch,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <remarks> The non-generic overloads of the Index, IndexAsync, and IndexWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> <returns> Response containing the status of operations for all actions in the batch. </returns> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Index``1(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.IndexBatch{``0},Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <returns> Response containing the status of operations for all actions in the batch. </returns> <remarks> The generic overloads of the Index and IndexAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.IndexAsync``1(Microsoft.Azure.Search.IDocumentsOperations,Microsoft.Azure.Search.Models.IndexBatch{``0},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <returns> Response containing the status of operations for all actions in the batch. </returns> <remarks> The generic overloads of the Index and IndexAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Search(Microsoft.Azure.Search.IDocumentsOperations,System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.SearchAsync(Microsoft.Azure.Search.IDocumentsOperations,System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Search``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.SearchAsync``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Suggest(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The non-generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.SuggestAsync(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The non-generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.Suggest``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.DocumentsOperationsExtensions.SuggestAsync``1(Microsoft.Azure.Search.IDocumentsOperations,System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name='operations'> The operations group for this extension method. </param> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="T:Microsoft.Azure.Search.IDocumentsOperations"> <summary> Defines operations for querying an index and uploading, merging, and deleting documents. <see href="https://docs.microsoft.com/rest/api/searchservice/Document-operations" /> </summary> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.CountWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Queries the number of documents in the Azure Search index. </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.ContinueSearchWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.ContinueSearchWithHttpMessagesAsync``1(Microsoft.Azure.Search.Models.SearchContinuationToken,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves the next page of search results from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name="continuationToken"> Encapsulates the state required to fetch the next page of search results from the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> <para> Note that this method is not meant to help you implement paging of search results. You can implement paging using the <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Top">Top</c> and <c cref="P:Microsoft.Azure.Search.Models.SearchParameters.Skip">Skip</c> parameters to the <c cref="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)">Search</c> method. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the document. </returns> <remarks> The non-generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. This mapping does not have the benefit of precise type information from the index, so the mapping is not always correct. In particular, be aware of the following cases: <list type="bullet"> <item> <description> Any numeric value without a decimal point will be deserialized to System.Int64 (long in C#). </description> </item> <item> <description> Special double-precision floating point values such as NaN and Infinity will be deserialized as type System.String rather than System.Double. </description> </item> <item> <description> Any string field with a value formatted like a DateTimeOffset will be deserialized incorrectly. We recommend storing such values in Edm.DateTimeOffset fields rather than Edm.String fields. </description> </item> <item> <description> Any Edm.DateTimeOffset field will be deserialized as a System.DateTimeOffset, not System.DateTime. </description> </item> </list> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves a document from the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name="key"> The key of the document to retrieve; See <see href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules"/> for the rules for constructing valid document keys. </param> <param name="selectedFields"> List of field names to retrieve for the document; Any field not retrieved will have null or default as its corresponding property value in the returned object. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the document. </returns> <remarks> The generic overloads of the Get, GetAsync, and GetWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. Note that all Azure Search field types except collections are nullable, so we recommend using nullable primitive types for the properties of type T. The type mapping is as follows: <list type="table"> <listheader> <term>Azure Search field type</term> <description>.NET type</description> </listheader> <item> <term>Edm.String</term> <description>System.String (string in C#)</description> </item> <item> <term>Collection(Edm.String)</term> <description>IEnumerable<System.String></description> </item> <item> <term>Edm.Boolean</term> <description>System.Nullable<System.Boolean> (bool? in C#)</description> </item> <item> <term>Edm.Double</term> <description>System.Nullable<System.Double> (double? in C#)</description> </item> <item> <term>Edm.Int32</term> <description>System.Nullable<System.Int32> (int? in C#)</description> </item> <item> <term>Edm.Int64</term> <description>System.Nullable<System.Int64> (long? in C#)</description> </item> <item> <term>Edm.DateTimeOffset</term> <description> System.Nullable<System.DateTimeOffset> (DateTimeOffset? in C#) or System.Nullable<System.DateTime> (DateTime? in C#). Both types work, although we recommend using DateTimeOffset. When retrieving documents, DateTime values will always be in UTC. When indexing documents, DateTime values are interpreted as follows: <list type="table"> <item> <term>UTC DateTime</term> <description>Sent as-is to the index.</description> </item> <item> <term>Local DateTime</term> <description>Converted to UTC before being sent to the index.</description> </item> <item> <term>DateTime with unspecified time zone</term> <description>Assumed to be UTC and sent as-is to the index.</description> </item> </list> </description> </item> <item> <term>Edm.GeographyPoint</term> <description><c cref="T:Microsoft.Spatial.GeographyPoint">Microsoft.Spatial.GeographyPoint</c></description> </item> </list> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.IndexWithHttpMessagesAsync(Microsoft.Azure.Search.Models.IndexBatch,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <remarks> The non-generic overloads of the Index, IndexAsync, and IndexWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> <returns> Response containing the status of operations for all actions in the batch. </returns> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.IndexWithHttpMessagesAsync``1(Microsoft.Azure.Search.Models.IndexBatch{``0},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Sends a batch of upload, merge, and/or delete actions to the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <param name="batch"> The batch of index actions. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Search.IndexBatchException"> Thrown when some of the indexing actions failed, but other actions succeeded and modified the state of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch this exception and check its <c cref="P:Microsoft.Azure.Search.IndexBatchException.IndexingResults">IndexResult</c> property. This property reports the status of each indexing action in the batch, making it possible to determine the state of the index after a partial failure. </exception> <returns> Response containing the status of operations for all actions in the batch. </returns> <remarks> The generic overloads of the Index, IndexAsync, and IndexWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The non-generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.SearchWithHttpMessagesAsync``1(System.String,Microsoft.Azure.Search.Models.SearchParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Searches for documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Search-Documents"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name="searchText"> A full-text search query expression; Use null or "*" to match all documents. See <see href="https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"/> for more information about search query syntax. </param> <param name="searchParameters"> Parameters to further refine the search query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the documents matching the query. </returns> <remarks> <para> The generic overloads of the Search, SearchAsync, and SearchWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </para> <para> If Azure Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See <c cref="P:Microsoft.Azure.Search.Models.DocumentSearchResultBase`2.ContinuationToken">DocumentSearchResultBase.ContinuationToken</c> for more information. </para> </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.SuggestWithHttpMessagesAsync(System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The non-generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more information. </remarks> </member> <member name="M:Microsoft.Azure.Search.IDocumentsOperations.SuggestWithHttpMessagesAsync``1(System.String,System.String,Microsoft.Azure.Search.Models.SuggestParameters,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Suggests query terms based on input text and matching documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Suggestions"/> </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index. </typeparam> <param name="searchText"> The search text on which to base suggestions. </param> <param name="suggesterName"> The name of the suggester as specified in the suggesters collection that's part of the index definition. </param> <param name="suggestParameters"> Parameters to further refine the suggestion query. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> Response containing the suggested text and documents matching the query. </returns> <remarks> The generic overloads of the Suggest, SuggestAsync, and SuggestWithHttpMessagesAsync methods support mapping of Azure Search field types to .NET types via the type parameter T. See <see cref="M:Microsoft.Azure.Search.IDocumentsOperations.GetWithHttpMessagesAsync``1(System.String,System.Collections.Generic.IEnumerable{System.String},Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"/> for more details on the type mapping. </remarks> </member> <member name="T:Microsoft.Azure.Search.IIndexersOperations"> <summary> IndexersOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. </summary> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Determines whether or not the given indexer exists in the Azure Search service. </summary> <param name="indexerName"> The name of the indexer. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> A response with the value <c>true</c> if the indexer exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.ResetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Resets the change tracking state associated with an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to reset. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.RunWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Runs an Azure Search indexer on-demand. <see href="https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to run. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to create or update. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves an indexer definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.ListWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all indexers available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexers" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='indexer'> The definition of the indexer to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexersOperations.GetStatusWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Returns the current status and execution history of an indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" /> </summary> <param name='indexerName'> The name of the indexer for which to retrieve status. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="T:Microsoft.Azure.Search.IndexersOperations"> <summary> IndexersOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.#ctor(Microsoft.Azure.Search.SearchServiceClient)"> <summary> Initializes a new instance of the IndexersOperations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Search.IndexersOperations.Client"> <summary> Gets a reference to the SearchServiceClient </summary> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.ResetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Resets the change tracking state associated with an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to reset. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.RunWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Runs an Azure Search indexer on-demand. <see href="https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to run. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to create or update. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves an indexer definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" /> </summary> <param name='indexerName'> The name of the indexer to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.ListWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all indexers available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexers" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='indexer'> The definition of the indexer to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexersOperations.GetStatusWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Returns the current status and execution history of an indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" /> </summary> <param name='indexerName'> The name of the indexer for which to retrieve status. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Search.IndexersOperationsExtensions"> <summary> Operations for managing indexers. <see href="https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" /> </summary> <summary> Extension methods for IndexersOperations. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Exists(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Determines whether or not the given indexer exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="indexerName"> The name of the indexer. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> <c>true</c> if the indexer exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.ExistsAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Determines whether or not the given indexer exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="indexerName"> The name of the indexer. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> <c>true</c> if the indexer exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Reset(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Resets the change tracking state associated with an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to reset. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.ResetAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Resets the change tracking state associated with an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to reset. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Run(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Runs an Azure Search indexer on-demand. <see href="https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to run. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.RunAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Runs an Azure Search indexer on-demand. <see href="https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to run. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to create or update. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer or updates an indexer if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to create or update. </param> <param name='indexer'> The definition of the indexer to create or update. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Delete(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Deletes an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.DeleteAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Deletes an Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Get(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves an indexer definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.GetAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves an indexer definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.List(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Lists all indexers available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexers" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.ListAsync(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Lists all indexers available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexers" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.Create(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Creates a new Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexer'> The definition of the indexer to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.CreateAsync(Microsoft.Azure.Search.IIndexersOperations,Microsoft.Azure.Search.Models.Indexer,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexer'> The definition of the indexer to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.GetStatus(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Returns the current status and execution history of an indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer for which to retrieve status. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexersOperationsExtensions.GetStatusAsync(Microsoft.Azure.Search.IIndexersOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Returns the current status and execution history of an indexer. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexerName'> The name of the indexer for which to retrieve status. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="T:Microsoft.Azure.Search.AnalyzerAttribute"> <summary> Indicates that the <see cref="T:Microsoft.Azure.Search.Models.Field"/> generated by <see cref="T:Microsoft.Azure.Search.FieldBuilder"/> for the target property should have its <see cref="P:Microsoft.Azure.Search.Models.Field.Analyzer"/> property set to the specified analyzer. </summary> </member> <member name="M:Microsoft.Azure.Search.AnalyzerAttribute.#ctor(System.String)"> <summary> Indicates that the specified analyzer should be used. </summary> <param name="analyzerName"> The name of the analyzer. Use one of the names in <see cref="T:Microsoft.Azure.Search.Models.AnalyzerName.AsString"/> or the name of a custom analyzer. </param> </member> <member name="M:Microsoft.Azure.Search.FieldBuilder.BuildForType``1"> <summary> Creates a collection of <see cref="T:Microsoft.Azure.Search.Models.Field"/> objects corresponding to the properties of the type supplied. </summary> <typeparam name="T"> The type for which fields will be created, based on its properties. </typeparam> <returns>A collection of fields.</returns> </member> <member name="M:Microsoft.Azure.Search.FieldBuilder.BuildForType``1(Newtonsoft.Json.Serialization.IContractResolver)"> <summary> Creates a collection of <see cref="T:Microsoft.Azure.Search.Models.Field"/> objects corresponding to the properties of the type supplied. </summary> <typeparam name="T"> The type for which fields will be created, based on its properties. </typeparam> <param name="contractResolver"> Contract resolver that the <see cref="T:Microsoft.Azure.Search.SearchIndexClient"/> will use. This ensures that the field names are generated in a way that is consistent with the way the model will be serialized. </param> <returns>A collection of fields.</returns> </member> <member name="T:Microsoft.Azure.Search.IIndexesOperations"> <summary> IndexesOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index or updates an index if it already exists. </summary> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Determines whether or not the given index exists in the Azure Search service. </summary> <param name="indexName"> The name of the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <returns> A response with the value <c>true</c> if the index exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.GetClient(System.String)"> <summary> Creates a new index client for querying and managing documents in a given index. </summary> <param name="indexName">The name of the index.</param> <returns>A new <c cref="T:Microsoft.Azure.Search.SearchIndexClient">SearchIndexClient</c> instance.</returns> <remarks> The new client is configured with full read-write access to the index. If you are only planning to use the client for query operations, we recommend directly creating a <c cref="T:Microsoft.Azure.Search.SearchIndexClient">SearchIndexClient</c> instance instead. </remarks> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Index,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> <param name='index'> The definition of the index to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.ListWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all indexes available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes" /> </summary> <param name='select'> Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index or updates an index if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" /> </summary> <param name='indexName'> The definition of the index to create or update. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search index and all the documents it contains. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Index" /> </summary> <param name='indexName'> The name of the index to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves an index definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index" /> </summary> <param name='indexName'> The name of the index to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.GetStatisticsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Returns statistics for the given index, including a document count and storage usage. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" /> </summary> <param name='indexName'> The name of the index for which to retrieve statistics. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Search.IIndexesOperations.AnalyzeWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.AnalyzeRequest,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Shows how an analyzer breaks text into tokens. <see href="https://docs.microsoft.com/rest/api/searchservice/test-analyzer" /> </summary> <param name='indexName'> The name of the index for which to test an analyzer. </param> <param name='request'> The text and analyzer or analysis components to test. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="T:Microsoft.Azure.Search.IndexAnalyzerAttribute"> <summary> Indicates that the <see cref="T:Microsoft.Azure.Search.Models.Field"/> generated by <see cref="T:Microsoft.Azure.Search.FieldBuilder"/> for the target property should have its <see cref="P:Microsoft.Azure.Search.Models.Field.IndexAnalyzer"/> property set to the specified analyzer. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexAnalyzerAttribute.#ctor(System.String)"> <summary> Indicates that the specified analyzer should be used. </summary> <param name="analyzerName"> The name of the analyzer. Use one of the names in <see cref="T:Microsoft.Azure.Search.Models.AnalyzerName.AsString"/> or the name of a custom analyzer. </param> </member> <member name="T:Microsoft.Azure.Search.IndexesOperations"> <summary> IndexesOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.CreateOrUpdateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.ExistsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.GetClient(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.#ctor(Microsoft.Azure.Search.SearchServiceClient)"> <summary> Initializes a new instance of the IndexesOperations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Search.IndexesOperations.Client"> <summary> Gets a reference to the SearchServiceClient </summary> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.CreateWithHttpMessagesAsync(Microsoft.Azure.Search.Models.Index,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> <param name='index'> The definition of the index to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.ListWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all indexes available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes" /> </summary> <param name='select'> Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.CreateOrUpdateWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index or updates an index if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" /> </summary> <param name='indexName'> The definition of the index to create or update. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.DeleteWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Deletes an Azure Search index and all the documents it contains. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Index" /> </summary> <param name='indexName'> The name of the index to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.GetWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Retrieves an index definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index" /> </summary> <param name='indexName'> The name of the index to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.GetStatisticsWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Returns statistics for the given index, including a document count and storage usage. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" /> </summary> <param name='indexName'> The name of the index for which to retrieve statistics. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Search.IndexesOperations.AnalyzeWithHttpMessagesAsync(System.String,Microsoft.Azure.Search.Models.AnalyzeRequest,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Shows how an analyzer breaks text into tokens. <see href="https://docs.microsoft.com/rest/api/searchservice/test-analyzer" /> </summary> <param name='indexName'> The name of the index for which to test an analyzer. </param> <param name='request'> The text and analyzer or analysis components to test. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Search.IndexesOperationsExtensions"> <summary> Operations for managing indexes. <see href="https://docs.microsoft.com/rest/api/searchservice/Index-operations" /> </summary> <summary> Extension methods for IndexesOperations. </summary> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search index or updates an index if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index or updates an index if it already exists. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.Exists(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Determines whether or not the given index exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="indexName"> The name of the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> <c>true</c> if the index exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.ExistsAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Determines whether or not the given index exists in the Azure Search service. </summary> <param name='operations'> The operations group for this extension method. </param> <param name="indexName"> The name of the index. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> <c>true</c> if the index exists; <c>false</c> otherwise. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.ListNames(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Lists the names of all indexes available for an Azure Search service. Use this instead of List() when you only need index names. It will save bandwidth and resource utilization, especially if your Search Service has many indexes. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <returns> The list of all index names for the search service. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.ListNamesAsync(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Lists the names of all indexes available for an Azure Search service. Use this instead of List() when you only need index names. It will save bandwidth and resource utilization, especially if your Search Service has many indexes. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes"/> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> <returns> The list of all index names for the search service. </returns> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.Create(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.Index,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Creates a new Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='index'> The definition of the index to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.CreateAsync(Microsoft.Azure.Search.IIndexesOperations,Microsoft.Azure.Search.Models.Index,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='index'> The definition of the index to create. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.List(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Lists all indexes available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='select'> Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.ListAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Lists all indexes available for an Azure Search service. <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='select'> Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.CreateOrUpdate(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Creates a new Azure Search index or updates an index if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The definition of the index to create or update. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.CreateOrUpdateAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.Index,System.Nullable{System.Boolean},Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Creates a new Azure Search index or updates an index if it already exists. <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The definition of the index to create or update. </param> <param name='index'> The definition of the index to create or update. </param> <param name='allowIndexDowntime'> Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.Delete(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition)"> <summary> Deletes an Azure Search index and all the documents it contains. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.DeleteAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,Microsoft.Azure.Search.Models.AccessCondition,System.Threading.CancellationToken)"> <summary> Deletes an Azure Search index and all the documents it contains. <see href="https://docs.microsoft.com/rest/api/searchservice/Delete-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index to delete. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='accessCondition'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.Get(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Retrieves an index definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.GetAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Retrieves an index definition from Azure Search. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index to retrieve. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.GetStatistics(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Returns statistics for the given index, including a document count and storage usage. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index for which to retrieve statistics. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.GetStatisticsAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Returns statistics for the given index, including a document count and storage usage. <see href="https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index for which to retrieve statistics. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.Analyze(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.AnalyzeRequest,Microsoft.Azure.Search.Models.SearchRequestOptions)"> <summary> Shows how an analyzer breaks text into tokens. <see href="https://docs.microsoft.com/rest/api/searchservice/test-analyzer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index for which to test an analyzer. </param> <param name='request'> The text and analyzer or analysis components to test. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> </member> <member name="M:Microsoft.Azure.Search.IndexesOperationsExtensions.AnalyzeAsync(Microsoft.Azure.Search.IIndexesOperations,System.String,Microsoft.Azure.Search.Models.AnalyzeRequest,Microsoft.Azure.Search.Models.SearchRequestOptions,System.Threading.CancellationToken)"> <summary> Shows how an analyzer breaks text into tokens. <see href="https://docs.microsoft.com/rest/api/searchservice/test-analyzer" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='indexName'> The name of the index for which to test an analyzer. </param> <param name='request'> The text and analyzer or analysis components to test. </param> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="T:Microsoft.Azure.Search.IsFacetableAttribute"> <summary> Indicates that it is possible to facet on this field. Not valid for geo-point fields. </summary> </member> <member name="T:Microsoft.Azure.Search.IsFilterableAttribute"> <summary> Indicates that the field can be used in filter expressions. </summary> </member> <member name="T:Microsoft.Azure.Search.IsRetrievableAttribute"> <summary> Indicates whether the field can be returned in a search result. This defaults to true, so this attribute only has any effect if you use it as [IsRetrievable(false)]. </summary> </member> <member name="T:Microsoft.Azure.Search.IsSearchableAttribute"> <summary> Causes the field to be included in full-text searches. Valid only for string or string collection fields. </summary> </member> <member name="T:Microsoft.Azure.Search.IsSortableAttribute"> <summary> Indicates that the field can be used in orderby expressions. Not valid for string collection fields. </summary> </member> <member name="T:Microsoft.Azure.Search.SearchAnalyzerAttribute"> <summary> Indicates that the <see cref="T:Microsoft.Azure.Search.Models.Field"/> generated by <see cref="T:Microsoft.Azure.Search.FieldBuilder"/> for the target property should have its <see cref="P:Microsoft.Azure.Search.Models.Field.SearchAnalyzer"/> property set to the specified analyzer. </summary> </member> <member name="M:Microsoft.Azure.Search.SearchAnalyzerAttribute.#ctor(System.String)"> <summary> Indicates that the specified analyzer should be used. </summary> <param name="analyzerName"> The name of the analyzer. Use one of the names in <see cref="T:Microsoft.Azure.Search.Models.AnalyzerName.AsString"/> or the name of a custom analyzer. </param> </member> <member name="T:Microsoft.Azure.Search.Serialization.ConverterBase"> <summary> Base class for custom JsonConverters. </summary> </member> <member name="M:Microsoft.Azure.Search.Serialization.ConverterBase.ExpectAndAdvance(Newtonsoft.Json.JsonReader,Newtonsoft.Json.JsonToken,System.Object)"> <summary> Asserts that the given JSON reader is positioned on a token with the expected type. Optionally asserts that the value of the token matches a given expected value. If any of the assertions fail, this method throws a JsonSerializationException. Otherwise, this method attempts to advance the JSON reader to the next position. </summary> <param name="reader">The JSON reader.</param> <param name="expectedToken">The JSON token on which the reader is expected to be positioned.</param> <param name="expectedValue">Optional; The expected value of the current JSON token.</param> </member> <member name="M:Microsoft.Azure.Search.Serialization.ConverterBase.ExpectAndAdvance``1(Newtonsoft.Json.JsonReader,Newtonsoft.Json.JsonToken,System.Object)"> <summary> Asserts that the given JSON reader is positioned on a token with the expected type and retrieves the value of the token, if any. Optionally asserts that the value of the token matches a given expected value. If any of the assertions fail, this method throws a JsonSerializationException. Otherwise, this method attempts to advance the JSON reader to the next position. </summary> <typeparam name="TValue">The expected type of the value of the current JSON token.</typeparam> <param name="reader">The JSON reader.</param> <param name="expectedToken">The JSON token on which the reader is expected to be positioned.</param> <param name="expectedValue">Optional; The expected value of the current JSON token.</param> <returns> The value of the JSON token before advancing the reader, or default(TValue) if the token has no value. </returns> </member> <member name="M:Microsoft.Azure.Search.Serialization.ConverterBase.Expect(Newtonsoft.Json.JsonReader,Newtonsoft.Json.JsonToken,System.Object)"> <summary> Asserts that the given JSON reader is positioned on a token with the expected type. Optionally asserts that the value of the token matches a given expected value. If any of the assertions fail, this method throws a JsonSerializationException. </summary> <param name="reader">The JSON reader.</param> <param name="expectedToken">The JSON token on which the reader is expected to be positioned.</param> <param name="expectedValue">Optional; The expected value of the current JSON token.</param> </member> <member name="M:Microsoft.Azure.Search.Serialization.ConverterBase.Expect``1(Newtonsoft.Json.JsonReader,Newtonsoft.Json.JsonToken,System.Object)"> <summary> Asserts that the given JSON reader is positioned on a token with the expected type and retrieves the value of the token, if any. Optionally asserts that the value of the token matches a given expected value. If any of the assertions fail, this method throws a JsonSerializationException. </summary> <typeparam name="TValue">The expected type of the value of the current JSON token.</typeparam> <param name="reader">The JSON reader.</param> <param name="expectedToken">The JSON token on which the reader is expected to be positioned.</param> <param name="expectedValue">Optional; The expected value of the current JSON token.</param> <returns> The value of the current JSON token, or default(TValue) if the current token has no value. </returns> </member> <member name="M:Microsoft.Azure.Search.Serialization.ConverterBase.Advance(Newtonsoft.Json.JsonReader)"> <summary> Advances the given JSON reader, or throws a JsonSerializationException if it cannot be advanced. </summary> <param name="reader">The JSON reader to advance.</param> </member> <member name="T:Microsoft.Azure.Search.Serialization.ExtensibleEnumValueFactory`1"> <summary> Delegate type for a factory method that creates or looks up an ExtensibleEnum instance from a given string. </summary> <typeparam name="T">The type of ExtensibleEnum returned.</typeparam> <param name="name">The enum value to look up or create.</param> <returns>An instance of type T.</returns> </member> <member name="T:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1"> <summary> Serializes and deserializes "extensible enums" to and from JSON. Extensible enums are like enumerations in that they have well-known values, but they are extensible with new values and the values are based on strings instead of integers. </summary> </member> <member name="M:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1.#ctor"> <summary> Initializes a new instance of the ExtensibleEnumConverter class. </summary> </member> <member name="M:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1.#ctor(System.String)"> <summary> Initializes a new instance of the ExtensibleEnumConverter class. </summary> <param name="factoryMethodName"> The name of a public static method that creates an instance of type T given a string value; Default is "Create". </param> </member> <member name="M:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1.CanConvert(System.Type)"> <summary> Indicates whether this converter can serialize or deserialize objects of the given type. </summary> <param name="objectType">The type to test against.</param> <returns>true if objectType derives from ExtensibleEnum, false otherwise.</returns> </member> <member name="M:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Deserializes a string into an ExtensibleEnum. </summary> <param name="reader">The JSON reader.</param> <param name="objectType">Ignored by this method.</param> <param name="existingValue">Ignored by this method.</param> <param name="serializer">Ignored by this method.</param> <returns>An instance of type T, or null if the current JSON token is null.</returns> </member> <member name="M:Microsoft.Azure.Search.Serialization.ExtensibleEnumConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Serializes an ExtensibleEnum to a JSON string. </summary> <param name="writer">The JSON writer.</param> <param name="value">The value to serialize.</param> <param name="serializer">Ignored by this method.</param> </member> <member name="T:Microsoft.Azure.Search.Serialization.DateTimeConverter"> <summary> Converts System.DateTime objects to System.DateTimeOffset before serialization. </summary> </member> <member name="T:Microsoft.Azure.Search.Serialization.DocumentConverter"> <summary> Deserializes JSON objects and arrays to .NET types instead of JObject and JArray. </summary> </member> <member name="T:Microsoft.Azure.Search.Serialization.GeographyPointConverter"> <summary> Serializes Microsoft.Spatial.GeographyPoint objects to Geo-JSON and vice-versa. </summary> </member> <member name="T:Microsoft.Azure.Search.Serialization.IndexActionConverter`1"> <summary> Serializes IndexAction instances so that the JSON is OData-compliant. </summary> <typeparam name="T"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> </member> <member name="T:Microsoft.Azure.Search.Serialization.InjectingJsonWriter"> <summary> Allows injection of arbitrary JSON during serialization via a callback. </summary> </member> <member name="T:Microsoft.Azure.Search.Serialization.SearchResultConverter`2"> <summary> Deserializes SearchResult instances from OData-compliant JSON. </summary> <typeparam name="TDoc"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <typeparam name="TResult"> Type of the model class that encapsulates documents in a search response. </typeparam> </member> <member name="T:Microsoft.Azure.Search.Serialization.SuggestResultConverter`2"> <summary> Deserializes SuggestResult instances from OData-compliant JSON. </summary> <typeparam name="TDoc"> The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index. </typeparam> <typeparam name="TResult"> Type of the model class that encapsulates documents in a suggestion response. </typeparam> </member> <member name="T:Microsoft.Azure.Search.DocumentsProxyOperations"> <summary> DocumentsProxyOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.DocumentsProxyOperations.#ctor(Microsoft.Azure.Search.SearchIndexClient)"> <summary> Initializes a new instance of the DocumentsProxyOperations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Search.DocumentsProxyOperations.Client"> <summary> Gets a reference to the SearchIndexClient </summary> </member> <member name="M:Microsoft.Azure.Search.DocumentsProxyOperations.CountWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Queries the number of documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Count-Documents" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Search.IDocumentsProxyOperations"> <summary> DocumentsProxyOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Search.IDocumentsProxyOperations.CountWithHttpMessagesAsync(Microsoft.Azure.Search.Models.SearchRequestOptions,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Queries the number of documents in the Azure Search index. <see href="https://docs.microsoft.com/rest/api/searchservice/Count-Documents" /> </summary> <param name='searchRequestOptions'> Additional parameters for the operation </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Rest.Azure.CloudException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> </members> </doc> |