SearchClientOptions Class

  • Reference

Definition

Namespace:
Azure.Search.Documents
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchClientOptions.cs
Source:
SearchClientOptions.cs

Provides the client configuration options for connecting to Azure Cognitive Search.

public class SearchClientOptions : Azure.Core.ClientOptions
type SearchClientOptions = class
    inherit ClientOptions
Public Class SearchClientOptions
Inherits ClientOptions
Inheritance
Object
ClientOptions
SearchClientOptions

Constructors

SearchClientOptions(SearchClientOptions+ServiceVersion)

Initializes a new instance of the SearchClientOptions class.

Properties

Audience

Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
Retry

Gets the client retry options.

(Inherited from ClientOptions)
RetryPolicy

Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

(Inherited from ClientOptions)
Serializer

Gets or sets an ObjectSerializer that can be used to customize the serialization of strongly typed models. The serializer needs to support JSON and JsonObjectSerializer will be used if no value is provided.
Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)
Version

Gets the SearchClientOptions.ServiceVersion of the service API used when making requests. For more, see API versions in Azure Cognitive Search.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)

Applies to