Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.jobarrays
[Groovy] Class JobArray

java.lang.Object
  com.ace.mws.jobarrays.JobArray

class JobArray

Job arrays are an easy way to submit many sub-jobs that perform the same work using the same script, but operate on different sets of data. Sub-jobs are the jobs created by an array job and are identified by the array job ID and an index; for example, if 235[1] is an identifier, the number 235 is a job array ID, and 1 is the sub-job.

Authors:
bsaville

Field Summary
private CancellationPolicyInformation cancellationPolicy

Represents the cancellation policy to use for the job array.
private List indexRanges

(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices.

private List indexValues

(Long collection) The index values to use for the sub-jobs.

private Job jobPrototype

The definition of the job to use for each sub-job.
private String name

The name of the job array.

private Long slotLimit

(Optional) The number of sub-jobs in the array that can run at a time.
 
Constructor Summary
JobArray()

 
Method Summary
CancellationPolicyInformation getCancellationPolicy()

Represents the cancellation policy to use for the job array.
List getIndexRanges()

(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices.

List getIndexValues()

(Long collection) The index values to use for the sub-jobs.

Job getJobPrototype()

The definition of the job to use for each sub-job.
String getName()

The name of the job array.

Long getSlotLimit()

(Optional) The number of sub-jobs in the array that can run at a time.
void setCancellationPolicy(CancellationPolicyInformation cancellationPolicy)

Represents the cancellation policy to use for the job array.
void setIndexRanges(List indexRanges)

(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices.

void setIndexValues(List indexValues)

(Long collection) The index values to use for the sub-jobs.

void setJobPrototype(Job jobPrototype)

The definition of the job to use for each sub-job.
void setName(String name)

The name of the job array.

void setSlotLimit(Long slotLimit)

(Optional) The number of sub-jobs in the array that can run at a time.
String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

cancellationPolicy

private CancellationPolicyInformation cancellationPolicy
Represents the cancellation policy to use for the job array.

indexRanges

private List indexRanges
(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices. To use hard-coded values, see indexValues.
See Also:
JobArrayIndexRange

indexValues

private List indexValues
(Long collection) The index values to use for the sub-jobs. To use ranges, see indexRanges.
See Also:
Long

jobPrototype

private Job jobPrototype
The definition of the job to use for each sub-job.

name

private String name
The name of the job array. In MWS API version 1, this is stored in the name field of the created jobs. In MWS API version 2, this is stored in the customName field of the created jobs.

slotLimit

private Long slotLimit
(Optional) The number of sub-jobs in the array that can run at a time.

 
Constructor Detail

JobArray

JobArray()

 
Method Detail

getCancellationPolicy

CancellationPolicyInformation getCancellationPolicy()
Represents the cancellation policy to use for the job array.

getIndexRanges

List getIndexRanges()
(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices. To use hard-coded values, see indexValues.
See Also:
JobArrayIndexRange

getIndexValues

List getIndexValues()
(Long collection) The index values to use for the sub-jobs. To use ranges, see indexRanges.
See Also:
Long

getJobPrototype

Job getJobPrototype()
The definition of the job to use for each sub-job.

getName

String getName()
The name of the job array. In MWS API version 1, this is stored in the name field of the created jobs. In MWS API version 2, this is stored in the customName field of the created jobs.

getSlotLimit

Long getSlotLimit()
(Optional) The number of sub-jobs in the array that can run at a time.

setCancellationPolicy

void setCancellationPolicy(CancellationPolicyInformation cancellationPolicy)
Represents the cancellation policy to use for the job array.

setIndexRanges

void setIndexRanges(List indexRanges)
(JobArrayIndexRange collection) The index ranges used to generate the sub-job indices. To use hard-coded values, see indexValues.
See Also:
JobArrayIndexRange

setIndexValues

void setIndexValues(List indexValues)
(Long collection) The index values to use for the sub-jobs. To use ranges, see indexRanges.
See Also:
Long

setJobPrototype

void setJobPrototype(Job jobPrototype)
The definition of the job to use for each sub-job.

setName

void setName(String name)
The name of the job array. In MWS API version 1, this is stored in the name field of the created jobs. In MWS API version 2, this is stored in the customName field of the created jobs.

setSlotLimit

void setSlotLimit(Long slotLimit)
(Optional) The number of sub-jobs in the array that can run at a time.

toString

String toString()

 

Groovy Documentation