BatchServiceModels.TaskUpdateOptionalParams.yml

### YamlMime:TSType
name: TaskUpdateOptionalParams
uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams'
package: '@azure/batch'
summary: Optional Parameters.
fullName: TaskUpdateOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: constraints
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.constraints'
    package: '@azure/batch'
    summary: >-
      Constraints that apply to this Task. If omitted, the Task is given the
      default constraints.

      For multi-instance Tasks, updating the retention time applies only to the
      primary Task and not

      subtasks.
    fullName: constraints
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'constraints?: TaskConstraints'
      return:
        description: ''
        type: <xref uid="@azure/batch.BatchServiceModels.TaskConstraints" />
  - name: taskUpdateOptions
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.taskUpdateOptions'
    package: '@azure/batch'
    summary: Additional parameters for the operation
    fullName: taskUpdateOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'taskUpdateOptions?: TaskUpdateOptions'
      return:
        description: ''
        type: <xref uid="@azure/batch.BatchServiceModels.TaskUpdateOptions" />
inheritedProperties:
  - name: abortSignal
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.abortSignal'
    package: '@azure/batch'
    summary: The signal which can be used to abort requests.
    fullName: abortSignal
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.AbortSignalLike" />
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.abortSignal
  - name: customHeaders
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.customHeaders'
    package: '@azure/batch'
    summary: |-
      User defined custom request headers that
      will be applied before the request is sent.
    fullName: customHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customHeaders?: {[key: string]: string}'
      return:
        description: ''
        type: '{[key: string]: string}'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.customHeaders
  - name: onDownloadProgress
    uid: >-
      @azure/batch.BatchServiceModels.TaskUpdateOptionalParams.onDownloadProgress
    package: '@azure/batch'
    summary: Callback which fires upon download progress.
    fullName: onDownloadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onDownloadProgress
  - name: onUploadProgress
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.onUploadProgress'
    package: '@azure/batch'
    summary: Callback which fires upon upload progress.
    fullName: onUploadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onUploadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onUploadProgress
  - name: timeout
    uid: '@azure/batch.BatchServiceModels.TaskUpdateOptionalParams.timeout'
    package: '@azure/batch'
    summary: >-
      The number of milliseconds a request can take before automatically being
      terminated.
    fullName: timeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'timeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.timeout
extends: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />