PollOperationState.yml

### YamlMime:TSType
name: PollOperationState
uid: '@azure/keyvault-keys.PollOperationState'
package: '@azure/keyvault-keys'
summary: >-
  PollOperationState contains an opinionated list of the smallest set of
  properties needed

  to define any long running operation poller.


  While the Poller class works as the local control mechanism to start
  triggering, wait for,

  and potentially cancel a long running operation, the PollOperationState
  documents the status

  of the remote long running operation.


  It should be updated at least when the operation starts, when it's finished,
  and when it's cancelled.

  Though, implementations can have any other number of properties that can be
  updated by other reasons.
fullName: PollOperationState<TResult>
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: error
    uid: '@azure/keyvault-keys.PollOperationState.error'
    package: '@azure/keyvault-keys'
    summary: Will exist if the operation encountered any error.
    fullName: error
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'error?: Error'
      return:
        description: ''
        type: Error
  - name: isCancelled
    uid: '@azure/keyvault-keys.PollOperationState.isCancelled'
    package: '@azure/keyvault-keys'
    summary: True if the operation has been cancelled.
    fullName: isCancelled
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isCancelled?: boolean'
      return:
        description: ''
        type: boolean
  - name: isCompleted
    uid: '@azure/keyvault-keys.PollOperationState.isCompleted'
    package: '@azure/keyvault-keys'
    summary: True if the operation has been completed.
    fullName: isCompleted
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isCompleted?: boolean'
      return:
        description: ''
        type: boolean
  - name: isStarted
    uid: '@azure/keyvault-keys.PollOperationState.isStarted'
    package: '@azure/keyvault-keys'
    summary: True if the operation has started.
    fullName: isStarted
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isStarted?: boolean'
      return:
        description: ''
        type: boolean
  - name: result
    uid: '@azure/keyvault-keys.PollOperationState.result'
    package: '@azure/keyvault-keys'
    summary: Will exist if the operation concluded in a result of an expected type.
    fullName: result
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'result?: TResult'
      return:
        description: ''
        type: TResult