This interface defines the options that can be sent into the copy data set function.

### Hierarchy

- IZosFilesOptions
  - ICopyDatasetOptions
    - ICrossLparCopyDatasetOptions

## Index

### Properties

- enq
- from-dataset
- overwrite
- progress
- promptFn
- promptForIdenticalNamedMembers
- replace
- responseTimeout
- safeReplace
- task

## Properties

### Optional enq

enq: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:31

Enq option Allow values are: SHR, SHRW, EXCLU.

### from-dataset

from-dataset: IDataSet

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:24

The dataset to copy from.

### Optional overwrite

overwrite: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:43

Overwrite option

### Optional progress

progress: IHandlerProgressApi

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:76

Apis to create and destroy progress bars during the command.

memberof

  IHandlerResponseApi

### Optional promptFn

promptFn: (targetDSN: string) => Promise<boolean>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:56

Prompt callback that will be invoked before overwiting a data set.

param

  Name of data set that already exists

returns

  True if target data set should be overwritten

#### Type declaration

- - (targetDSN: string): Promise<boolean>

  - #### Parameters

    - ##### targetDSN: string

    #### Returns Promise<boolean>

### Optional promptForIdenticalNamedMembers

promptForIdenticalNamedMembers: () => Promise<boolean>

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:62

Prompt for duplicates

returns

  `True` if the copy operation will overwrite an existing member; `false` otherwise

#### Type declaration

- - (): Promise<boolean>

  - #### Returns Promise<boolean>

### Optional replace

replace: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:37

Replace option

### Optional responseTimeout

responseTimeout: number

Inherited from IZosFilesOptions.responseTimeout

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IZosFilesOptions.ts:22

The maximum amount of time for the TSO servlet to wait for a response before returning an error

### Optional safeReplace

safeReplace: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:49

Safe replace option

### Optional task

task: ITaskWithStatus

- Defined in @zowe/zos-files-for-zowe-sdk/src/methods/copy/doc/ICopyDatasetOptions.ts:69

Task status object used by CLI handlers to create progress bars Optional

Generated using TypeDoc