Interface IZosWorkLoad
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IZosWorkLoad extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IZosWorkLoad.CpuCriticalValue
Enumeration type for field MNGWLMCCstatic class
IZosWorkLoad.GoalManagementValue
Enumeration type for field MNGWLMGMstatic class
IZosWorkLoad.GoalModeValue
Enumeration type for field MNGWLMMDstatic class
IZosWorkLoad.GoalTypeValue
Enumeration type for field MNGWLMGTstatic class
IZosWorkLoad.HealthStatusValue
Enumeration type for field MNGWLMOSstatic class
IZosWorkLoad.StorageCriticalValue
Enumeration type for field MNGWLMSKstatic class
IZosWorkLoad.WlmServerValue
Enumeration type for field MNGWLMST
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCECMachineType()
Getter for field MNGMCHTPjava.lang.String
getCECModel()
Getter for field MNGMDLIDIZosWorkLoadReference
getCICSObjectReference()
IZosWorkLoad.CpuCriticalValue
getCpuCritical()
Getter for field MNGWLMCCjava.lang.Long
getGoalImportance()
Getter for field MNGWLMGIIZosWorkLoad.GoalManagementValue
getGoalManagement()
Getter for field MNGWLMGMIZosWorkLoad.GoalModeValue
getGoalMode()
Getter for field MNGWLMMDIZosWorkLoad.GoalTypeValue
getGoalType()
Getter for field MNGWLMGTjava.lang.Long
getHealthIndicator()
Getter for field MNGWLMHLjava.lang.Long
getHealthIndicatorAdjustmentValue()
Getter for field MNGWLMADIZosWorkLoad.HealthStatusValue
getHealthStatus()
Getter for field MNGWLMOSjava.lang.Long
getHealthUpdateInterval()
Getter for field MNGWLMINjava.util.Date
getLastHealthUpdateTime()
Getter for field MNGWLMHTICICSType<IZosWorkLoad>
getObjectType()
java.lang.String
getReportClass()
Getter for field MNGWLMRCjava.lang.String
getResourceGroup()
Getter for field MNGWLMRGjava.lang.String
getServiceClass()
Getter for field MNGWLMSCIZosWorkLoad.StorageCriticalValue
getStorageCritical()
Getter for field MNGWLMSKjava.lang.Long
getVelocityGoalValue()
Getter for field MNGWLMGVIZosWorkLoad.WlmServerValue
getWlmServer()
Getter for field MNGWLMSTjava.lang.String
getWorkloadName()
Getter for field MNGWLMWN-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IZosWorkLoad> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getGoalMode
IZosWorkLoad.GoalModeValue getGoalMode()
Getter for field MNGWLMMDGoal mode
Indicates whether the MVS workload management component is running in goal mode. Values are:
- Yes
- The MVS workload management component is running in goal mode.
- No
- The MVS workload management component is running in compatibility mode.
Note - compatibility mode is only available on z/OS releases prior to z/OS V1R3.
-
getWlmServer
IZosWorkLoad.WlmServerValue getWlmServer()
Getter for field MNGWLMSTWLM server
Identifies whether or not the MVS workload management component is treating the CICS region as a server. Values are:
- Yes
- The MVS workload management component is treating the CICS region as a server and processing work based upon CICS subsystem definitions.
- No
- The MVS workload management component is treating the CICS region as a non-server address space. Work is being processed based upon JES (batch job) or STC (started task) subsystem definitions.
-
getServiceClass
java.lang.String getServiceClass()
Getter for field MNGWLMSCService class
Identifies the name of the MVS workload manager service class that has been assigned to the CICS region on the basis of the JES (batch job) or STC (started task) startup subsystem.
-
getReportClass
java.lang.String getReportClass()
Getter for field MNGWLMRCReport class
Identifies the name of the MVS workload manager report class that has been assigned to the CICS region on the basis of the JES (batch job) or STC (started task) startup subsystem. If no report class has been assigned, this field will be blank.
-
getResourceGroup
java.lang.String getResourceGroup()
Getter for field MNGWLMRGResource group
Identifies the name of the MVS workload manager resource group that has been assigned to the CICS region on the basis of the JES (batch job) or STC (started task) startup subsystem. If no resource group has been assigned, this field will be blank.
-
getWorkloadName
java.lang.String getWorkloadName()
Getter for field MNGWLMWNWorkload name
Identifies the name of the MVS workload management component workload name that has been assigned to the CICS region on the basis of the JES (batch job) or STC (started task) startup subsystem.
Note - this is different from the CICSPlex SM workload name that the CICS region may be participating in.
-
getGoalType
IZosWorkLoad.GoalTypeValue getGoalType()
Getter for field MNGWLMGTGoal type
The MVS workload manager goal type associated with the current service class. Values are:
- Velocity
- The MVS workload management component will assign resources to the service class in order to minimize delays.
- Discretionary
- The MVS workload management component will assign resources to the service class only if they are not required by other non-discretionary goals. This is typically used for low priority work.
- System
- The service class is one of the MVS workload manager predefined service classes; SYSTEM, SYSSTC, or SYSOTHER.
- Notapplic
- Unknown or undefined goal type.
-
getVelocityGoalValue
java.lang.Long getVelocityGoalValue()
Getter for field MNGWLMGVVelocity goal value
For MVS workload manager service classes that use a velocity goal this value indicates the acceptable amount of delay for the work.
This value will be 0 if the service class is not defined with a velocity goal.
-
getCpuCritical
IZosWorkLoad.CpuCriticalValue getCpuCritical()
Getter for field MNGWLMCCCPU critical
Indicates whether or not the CICS region is defined to the MVS workload management component with long-term CPU protection. Values are:
- Yes
- The CICS region is defined in the JES (batch job) or STC (started task) subsystems using a MVS workload manager service class that specifies CPU critical.
- No
- The CICS region is defined in the JES (batch job) or STC (started task) subsystems using a MVS workload manager service class that does not specify CPU critical.
-
getStorageCritical
IZosWorkLoad.StorageCriticalValue getStorageCritical()
Getter for field MNGWLMSKStorage critical
Indicates whether or not the CICS region is defined to the MVS workload management component with long-term storage protection. Values are:
- Yes
- The CICS region is classified in the JES (batch job) or STC (started task) subsystems using a MVS workload manager classification rule that specifies storage critical.
- No
- The CICS region is not classified in the JES (batch job) or STC (started task) subsystems using a MVS workload manager classification rule that specifies storage critical.
-
getGoalImportance
java.lang.Long getGoalImportance()
Getter for field MNGWLMGIGoal importance
Indicates the relative importance level defined in the MVS workload manager service class. Values are:
- 1
- Highest
- 2
- High
- 3
- Medium
- 4
- Low
- 5
- Lowest
-
getGoalManagement
IZosWorkLoad.GoalManagementValue getGoalManagement()
Getter for field MNGWLMGMGoal management
Indicates whether z/OS Workload Manager manages the address space using transaction goals, region goals or both. Values are:
- Transaction
- Workload manager uses transaction goals
- Region
- Workload manager uses region goals
- Both
- Workload manager uses both goals
- Notapplic
- Unknown or undefined goal mode
-
getCECMachineType
java.lang.String getCECMachineType()
Getter for field MNGMCHTPCEC machine type
CEC machine type for the address space.
-
getCECModel
java.lang.String getCECModel()
Getter for field MNGMDLIDCEC model number
CEC model identification number for the address space.
-
getHealthIndicatorAdjustmentValue
java.lang.Long getHealthIndicatorAdjustmentValue()
Getter for field MNGWLMADAdjustment value for z/OS WLM health
For CICS regions at level CICS TS 5.4 and higher, this is the current adjustment value that adjusts z/OS WLM health in the CICS address space at each interval
-
getHealthIndicator
java.lang.Long getHealthIndicator()
Getter for field MNGWLMHLz/OS WLM health
For CICS regions at level CICS TS 5.4 and higher, this is the percentage value that represents the z/OS WLM health open state for the region. A value of N/A is returned if WLMHEALTH=OFF is set in the SIT.
-
getLastHealthUpdateTime
java.util.Date getLastHealthUpdateTime()
Getter for field MNGWLMHTLast time z/OS WLM health was updated
For CICS regions at level CICS TS 5.4 and higher, this is the last time, in ABSTIME format, when z/OS WLM health was reported to z/OS WLM.
-
getHealthUpdateInterval
java.lang.Long getHealthUpdateInterval()
Getter for field MNGWLMINTime interval (seconds) between z/OS WLM health updates
For CICS regions at level CICS TS 5.4 and higher, this is the amount of time, in seconds, between calls that CICS make to the z/OS Workload Manager Health API
-
getHealthStatus
IZosWorkLoad.HealthStatusValue getHealthStatus()
Getter for field MNGWLMOSz/OS WLM health open status
For CICS regions at level CICS TS 5.4 and higher, this is the status of the z/OS WLM health process. The CVDA values are as follows:
- OPEN - Instructs CICS to start increasing z/OS WLM health until it has reached a value of 100 where it will remain in the OPEN state
- OPENING - CICS has started increasing z/OS WLM health, which is currently in the range 0 through 99.
- CLOSE - Instructs CICS to start decreasing z/OS WLM health until it has reached a value of 0.
- CLOSED - CICS has completed decreasing z/OS WLM health, which has reached a value of 0.
- CLOSING - CICS has started decreasing z/OS WLM health to 0, which is currently in the range 100 through 1.
- IMMCLOSING - CICS is in the process of immediately setting z/OS WLM health to 0.
- IMMCLOSE - Instructs CICS to immediately set z/OS WLM health to 0.
-
getCICSObjectReference
IZosWorkLoadReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-