azure.ai.textanalytics.TextAnalysisLROPoller.yml

### YamlMime:PythonClass
uid: azure.ai.textanalytics.TextAnalysisLROPoller
name: TextAnalysisLROPoller
fullName: azure.ai.textanalytics.TextAnalysisLROPoller
module: azure.ai.textanalytics
inheritances:
- typing_extensions.Protocol
summary: Implements a protocol which returned poller objects are consistent with.
constructor:
  syntax: TextAnalysisLROPoller(*args, **kwargs)
methods:
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.add_done_callback
  name: add_done_callback
  summary: 'Add callback function to be run once the long running operation

    has completed - regardless of the status of the operation.'
  signature: 'add_done_callback(func: Callable) -> None'
  parameters:
  - name: func
    description: 'Callback function that takes at least one

      argument, a completed LongRunningOperation.'
    isRequired: true
    types:
    - <xref:callable>
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.cancel
  name: cancel
  summary: Cancel the operation currently being polled.
  signature: cancel() -> None
  return:
    description: None
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: When the operation has already reached a terminal state.
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.continuation_token
  name: continuation_token
  summary: Return a continuation token that allows to restart the poller later.
  signature: continuation_token() -> str
  return:
    description: An opaque continuation token
    types:
    - <xref:str>
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.done
  name: done
  summary: Check status of the long running operation.
  signature: done() -> bool
  return:
    description: '''True'' if the process has completed, else ''False''.'
    types:
    - <xref:bool>
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.remove_done_callback
  name: remove_done_callback
  summary: Remove a callback from the long running operation.
  signature: 'remove_done_callback(func: Callable) -> None'
  parameters:
  - name: func
    description: The function to be removed from the callbacks.
    isRequired: true
    types:
    - <xref:callable>
  exceptions:
  - type: ValueError
    description: if the long running operation has already completed.
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.result
  name: result
  summary: 'Return the result of the long running operation, or

    the result available after the specified timeout.'
  signature: 'result(timeout: int | None = None) -> PollingReturnType_co'
  parameters:
  - name: timeout
    defaultValue: None
  return:
    description: 'The deserialized resource of the long running operation,

      if one is available.'
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: Server problem with the query.
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.status
  name: status
  summary: Returns the current status string.
  signature: status() -> str
  return:
    description: The current status string
    types:
    - <xref:str>
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.wait
  name: wait
  summary: 'Wait on the long running operation for a specified length

    of time. You can check if this call as ended with timeout with the

    "done()" method.'
  signature: 'wait(timeout: float | None = None) -> None'
  parameters:
  - name: timeout
    description: 'Period of time to wait for the long running

      operation to complete (in seconds).'
    defaultValue: None
    types:
    - <xref:float>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: Server problem with the query.
attributes:
- uid: azure.ai.textanalytics.TextAnalysisLROPoller.details
  name: details
  summary: Long-running operation metadata.
  return:
    description: A mapping of details about the long-running operation.
    types:
    - <xref:typing.Mapping>[<xref:str>, <xref:typing.Any>]