Interface to define input options for RestClient GET|POST|PUT|DELETE ExpectFullResponse methods

export
deprecated
  - Use Imperative's IOptionsFullResponse instead
interface

  IOptionsFullResponse

### Hierarchy

- IOptionsFullResponse

## Index

### Properties

- dataToReturn
- normalizeRequestNewLines
- normalizeResponseNewLines
- reqHeaders
- requestStream
- resource
- responseStream
- task
- writeData

## Properties

### Optional dataToReturn

dataToReturn: CLIENT_PROPERTY[]

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:34

List of properties to return from REST call

memberof

  IFullResponseOptions

### Optional normalizeRequestNewLines

normalizeRequestNewLines: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:78

true if you want \r\n to be replaced with \n when sending data to the server from requestStream. Don't set this for binary requests

memberof

  IOptionsFullResponse

### Optional normalizeResponseNewLines

normalizeResponseNewLines: boolean

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:70

true if you want newlines to be \r\n on windows when receiving data from the server to responseStream. Don't set this for binary responses

memberof

  IOptionsFullResponse

### Optional reqHeaders

reqHeaders: any[]

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:41

Headers to include with request

memberof

  IOptionsFullResponse

### Optional requestStream

requestStream: Readable

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

Stream for outgoing request data to the server

memberof

  IOptionsFullResponse

### resource

resource: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:28

URI for this request

memberof

  IOptionsFullResponse

### Optional responseStream

responseStream: Writable

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:55

Stream for incoming response data from the server. If specified, response data will not be buffered

memberof

  IOptionsFullResponse

### Optional task

task: ITaskWithStatus

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:85

Task that will automatically be updated to report progress of upload or download to user

memberof

  IOptionsFullResponse

### Optional writeData

writeData: any

- Defined in @zowe/zos-files-for-zowe-sdk/src/doc/IOptionsFullResponse.ts:48

Data to write on this REST request

memberof

  IOptionsFullResponse

Generated using TypeDoc