TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.yml

### YamlMime:TSType
name: TrainingAPIClientGetUntaggedImagesOptionalParams
uid: >-
  @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams
package: '@azure/cognitiveservices-customvision-training'
summary: Optional Parameters.
fullName: TrainingAPIClientGetUntaggedImagesOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: iterationId
    uid: >-
      @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.iterationId
    package: '@azure/cognitiveservices-customvision-training'
    summary: The iteration id. Defaults to workspace.
    fullName: iterationId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'iterationId?: string'
      return:
        description: ''
        type: string
  - name: orderBy
    uid: >-
      @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.orderBy
    package: '@azure/cognitiveservices-customvision-training'
    summary: >-
      The ordering. Defaults to newest. Possible values include: 'Newest',
      'Oldest'
    fullName: orderBy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'orderBy?: OrderBy3'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-customvision-training.TrainingAPIModels.OrderBy3"
          />
  - name: skip
    uid: >-
      @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.skip
    package: '@azure/cognitiveservices-customvision-training'
    summary: >-
      Number of images to skip before beginning the image batch. Defaults to 0.
      Default value: 0.
    fullName: skip
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'skip?: number'
      return:
        description: ''
        type: number
  - name: take
    uid: >-
      @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.take
    package: '@azure/cognitiveservices-customvision-training'
    summary: >-
      Maximum number of images to return. Defaults to 50, limited to 256.
      Default value: 50.
    fullName: take
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'take?: number'
      return:
        description: ''
        type: number
inheritedProperties:
  - name: abortSignal
    uid: >-
      @azure/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.abortSignal
    package: '@azure/cognitiveservices-customvision-training'
    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/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.customHeaders
    package: '@azure/cognitiveservices-customvision-training'
    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/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.onDownloadProgress
    package: '@azure/cognitiveservices-customvision-training'
    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/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.onUploadProgress
    package: '@azure/cognitiveservices-customvision-training'
    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/cognitiveservices-customvision-training.TrainingAPIModels.TrainingAPIClientGetUntaggedImagesOptionalParams.timeout
    package: '@azure/cognitiveservices-customvision-training'
    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" />