azure.search.documents.SearchIndexingBufferedSender.yml

### YamlMime:PythonClass
uid: azure.search.documents.SearchIndexingBufferedSender
name: SearchIndexingBufferedSender
fullName: azure.search.documents.SearchIndexingBufferedSender
module: azure.search.documents
inheritances:
- azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase
- azure.search.documents._headers_mixin.HeadersMixin
summary: A buffered sender for document indexing actions.
constructor:
  syntax: 'SearchIndexingBufferedSender(endpoint: str, index_name: str, credential:
    AzureKeyCredential | TokenCredential, **kwargs: Any)'
  parameters:
  - name: endpoint
    description: The URL endpoint of an Azure search service
    isRequired: true
    types:
    - <xref:str>
  - name: index_name
    description: The name of the index to connect to
    isRequired: true
    types:
    - <xref:str>
  - name: credential
    description: A credential to authorize search client requests
    isRequired: true
    types:
    - <xref:azure.core.credentials.AzureKeyCredential>
    - <xref:azure.core.credentials.TokenCredential>
  keywordOnlyParameters:
  - name: auto_flush_interval
    description: 'how many max seconds if between 2 flushes. This only takes effect

      when auto_flush is on. Default to 60 seconds.'
    types:
    - <xref:int>
  - name: initial_batch_action_count
    description: 'The initial number of actions to group into a batch when

      tuning the behavior of the sender. The default value is 512.'
    types:
    - <xref:int>
  - name: max_retries_per_action
    description: The number of times to retry a failed document. The default value
      is 3.
    types:
    - <xref:int>
  - name: on_new
    description: 'If it is set, the client will call corresponding methods when there

      is a new IndexAction added. This may be called from main thread or a worker
      thread.'
    types:
    - <xref:callable>
  - name: on_progress
    description: 'If it is set, the client will call corresponding methods when there

      is a IndexAction succeeds. This may be called from main thread or a worker thread.'
    types:
    - <xref:callable>
  - name: on_error
    description: 'If it is set, the client will call corresponding methods when there

      is a IndexAction fails. This may be called from main thread or a worker thread.'
    types:
    - <xref:callable>
  - name: on_remove
    description: 'If it is set, the client will call corresponding methods when there

      is a IndexAction removed from the queue (succeeds or fails). This may be called
      from main

      thread or a worker thread.'
    types:
    - <xref:callable>
  - name: api_version
    description: The Search API version to use for requests.
    types:
    - <xref:str>
  - name: audience
    description: 'sets the Audience to use for authentication with Azure Active Directory
      (AAD). The

      audience is not considered when using a shared key. If audience is not provided,
      the public cloud audience

      will be assumed.'
    types:
    - <xref:str>
methods:
- uid: azure.search.documents.SearchIndexingBufferedSender.close
  name: close
  summary: 'Close the session.

    :return: None

    :rtype: None'
  signature: close(**kwargs) -> None
- uid: azure.search.documents.SearchIndexingBufferedSender.delete_documents
  name: delete_documents
  summary: Queue delete documents actions
  signature: 'delete_documents(documents: List[Dict], **kwargs) -> None'
  parameters:
  - name: documents
    description: A list of documents to delete.
    isRequired: true
    types:
    - <xref:list>[<xref:dict>]
- uid: azure.search.documents.SearchIndexingBufferedSender.flush
  name: flush
  summary: Flush the batch.
  signature: 'flush(timeout: int = 86400, **kwargs: Any) -> bool'
  parameters:
  - name: timeout
    description: time out setting. Default is 86400s (one day)
    isRequired: true
    types:
    - <xref:int>
  return:
    description: True if there are errors. Else False
    types:
    - <xref:bool>
  exceptions:
  - type: azure.core.exceptions.ServiceResponseTimeoutError
- uid: azure.search.documents.SearchIndexingBufferedSender.index_documents
  name: index_documents
  summary: 'Specify a document operations to perform as a batch.


    :raises ~azure.search.documents.RequestEntityTooLargeError'
  signature: 'index_documents(batch: IndexDocumentsBatch, **kwargs) -> List[IndexingResult]'
  parameters:
  - name: batch
    description: A batch of document operations to perform.
    isRequired: true
    types:
    - <xref:azure.search.documents.IndexDocumentsBatch>
  return:
    description: Indexing result of each action in the batch.
    types:
    - <xref:list>[<xref:azure.search.documents.models.IndexingResult>]
- uid: azure.search.documents.SearchIndexingBufferedSender.merge_documents
  name: merge_documents
  summary: Queue merge documents actions
  signature: 'merge_documents(documents: List[Dict], **kwargs) -> None'
  parameters:
  - name: documents
    description: A list of documents to merge.
    isRequired: true
    types:
    - <xref:list>[<xref:dict>]
- uid: azure.search.documents.SearchIndexingBufferedSender.merge_or_upload_documents
  name: merge_or_upload_documents
  summary: Queue merge documents or upload documents actions
  signature: 'merge_or_upload_documents(documents: List[Dict], **kwargs) -> None'
  parameters:
  - name: documents
    description: A list of documents to merge or upload.
    isRequired: true
    types:
    - <xref:list>[<xref:dict>]
- uid: azure.search.documents.SearchIndexingBufferedSender.upload_documents
  name: upload_documents
  summary: Queue upload documents actions.
  signature: 'upload_documents(documents: List[Dict], **kwargs) -> None'
  parameters:
  - name: documents
    description: A list of documents to upload.
    isRequired: true
    types:
    - <xref:list>[<xref:dict>]
attributes:
- uid: azure.search.documents.SearchIndexingBufferedSender.actions
  name: actions
  summary: The list of currently index actions in queue to index.
  return:
    types:
    - <xref:list>[<xref:azure.search.documents.models.IndexAction>]