Interface for variable definition object.

export
interface

  IVariableDefinition

### Hierarchy

- IVariableDefinition

## Index

### Properties

- abstract
- category
- choice
- decimalPlaces
- default
- description
- exposeToUser
- maxLength
- maxValue
- minLength
- minValue
- name
- promptAtCreate
- regularExpression
- requiredAtCreate
- scope
- type
- validationType
- visibility

## Properties

### abstract

abstract: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:38

Brief description of variable.

memberof

  IVariableDefinition

### category

category: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:45

Name of logical variable group.

memberof

  IVariableDefinition

### choice

choice: string[]

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:52

Choice value.

memberof

  IVariableDefinition

### decimalPlaces

decimalPlaces: number

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:59

Maximum number of decimal places.

memberof

  IVariableDefinition

### default

default: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:66

Default value of variable.

memberof

  IVariableDefinition

### description

description: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:73

Description of variable.

memberof

  IVariableDefinition

### exposeToUser

exposeToUser: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:80

Whether variable displayed.

memberof

  IVariableDefinition

### maxLength

maxLength: number

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:87

Maximum length of variable value.

memberof

  IVariableDefinition

### maxValue

maxValue: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:94

Maximum value of variable.

memberof

  IVariableDefinition

### minLength

minLength: number

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:101

Minimum length of variable value.

memberof

  IVariableDefinition

### minValue

minValue: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:108

Minimum value of variable.

memberof

  IVariableDefinition

### name

name: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:24

Name of the variable.

memberof

  IVariableDefinition

### promptAtCreate

promptAtCreate: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:115

Whether variable is prompted at create.

memberof

  IVariableDefinition

### regularExpression

regularExpression: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:122

Standard regular expression.

memberof

  IVariableDefinition

### requiredAtCreate

requiredAtCreate: boolean

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:129

Whether variable must be specified.

memberof

  IVariableDefinition

### scope

scope: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:31

Variable scope.

memberof

  IVariableDefinition

### type

type: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:136

Type of variable.

memberof

  IVariableDefinition

### validationType

validationType: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:143

Validation type of variable.

memberof

  IVariableDefinition

### visibility

visibility: string

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/doc/IVariableDefinition.ts:150

Indicates if display variable to Workflows users (public or private).

memberof

  IVariableDefinition

Generated using TypeDoc