Attributes for a set of files relating to how they will be uploaded to USS

### Hierarchy

- ZosFilesAttributes

## Index

### Constructors

- constructor

### Properties

- attributes
- basePath
- MAX_EXPECTED_FIELDS
- MIN_EXPECTED_FIELDS

### Methods

- fileShouldBeIgnored
- fileShouldBeUploaded
- findLastMatchingAttributes
- getFileTransferMode
- getLocalEncoding
- getRemoteEncoding
- parse
- loadFromFile

## Constructors

### constructor

- new ZosFilesAttributes(attributesFileContents: string, basePath?: string): ZosFilesAttributes

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:36

  #### Parameters

  - ##### attributesFileContents: string

  - ##### Optional basePath: string

  #### Returns ZosFilesAttributes

## Properties

### Private attributes

attributes: Map<string, IUploadAttributes> = new Map<string,IUploadAttributes>()

- Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:35

### Private basePath

basePath: string

- Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:36

### Static Private MAX_EXPECTED_FIELDS

MAX_EXPECTED_FIELDS: number = 3

- Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:32

### Static Private MIN_EXPECTED_FIELDS

MIN_EXPECTED_FIELDS: number = 2

- Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:33

## Methods

### fileShouldBeIgnored

- fileShouldBeIgnored(path: string): boolean

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:97

  #### Parameters

  - ##### path: string

  #### Returns boolean

### fileShouldBeUploaded

- fileShouldBeUploaded(path: string): boolean

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:83

  #### Parameters

  - ##### path: string

  #### Returns boolean

### Private findLastMatchingAttributes

- findLastMatchingAttributes(path: string): IUploadAttributes

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:158

  #### Parameters

  - ##### path: string

  #### Returns IUploadAttributes

### getFileTransferMode

- getFileTransferMode(path: string, preferBinary?: boolean): TransferMode

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:101

  #### Parameters

  - ##### path: string

  - ##### Optional preferBinary: boolean

  #### Returns TransferMode

### getLocalEncoding

- getLocalEncoding(path: string): string

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:123

  #### Parameters

  - ##### path: string

  #### Returns string

### getRemoteEncoding

- getRemoteEncoding(path: string): string

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:114

  #### Parameters

  - ##### path: string

  #### Returns string

### Private parse

- parse(attributesFileContents: string): void

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:132

  #### Parameters

  - ##### attributesFileContents: string

  #### Returns void

### Static loadFromFile

- loadFromFile(filePath?: string, defaultDir?: string): ZosFilesAttributes | undefined

- - Defined in @zowe/zos-files-for-zowe-sdk/src/utils/ZosFilesAttributes.ts:43

  #### Parameters

  - ##### Optional filePath: string

  - ##### Optional defaultDir: string

  #### Returns ZosFilesAttributes | undefined

Generated using TypeDoc