Class GlaaSBatchInfo

Holds parameters to be used with GlaaSJob.SubmitBatchToGlaaS and GlaaSJob.SubmitDependentBatch.

Constructors

GlaaSBatchInfo(Int32, Int32, Int32, Int32, Boolean, String, Int32)

Create a GlaaSBatchInfo instance for use with GlaaSJob.SubmitBatchToGlaaS and GlaaSJob.SubmitDependentBatch.

Parameters

System.Int32 BatchId The ID of the batch to run.

System.Int32 Cores The number of cores to use.

System.Int32 Queues The number of queues to use.

System.Int32 MaxRunTimeInMinutes The maximum time the job can run in C4, in minutes. Using 0 means there is no max run time. Note that ELink will not throw an exception from this time being exceeded. Note: ELink does not check if this time is exceeded, but C4 will cancel the job. Optional. Default value = 0

System.Boolean StartProvisioningAfterUpload If true, then wait until uploading is complete before provisioning a farm. Otherwise, immediately provision a farm. Note: This parameter is ignored when submitted as a dependent batch. Optional. Default value = false

System.String Description A run description to use for this job. Optional. Default value = null

System.Int32 Priority Priority of the job. Higher values indicate higher priority. Optional. Default value = 0

GlaaSBatchInfo(String, Int32, Int32, Int32, Boolean, String, Int32)

Create a GlaaSBatchInfo instance for use with GlaaSJob.SubmitBatchToGlaaS and GlaaSJob.SubmitDependentBatch.

Parameters

System.String BatchName The name of the batch to run.

System.Int32 Cores The number of cores to use.

System.Int32 Queues The number of queues to use.

System.Int32 MaxRunTimeInMinutes The maximum time the job can run in C4, in minutes. Using 0 means there is no max run time. Note that ELink will not throw an exception from this time being exceeded. Note: ELink does not check if this time is exceeded, but C4 will cancel the job. Optional. Default value = 0

System.Boolean StartProvisioningAfterUpload If true, then wait until uploading is complete before provisioning a farm. Otherwise, immediately provision a farm. Note: This parameter is ignored when submitted as a dependent batch. Optional. Default value = false

System.String Description A run description to use for this job. Optional. Default value = null

System.Int32 Priority Priority of the job. Higher values indicate higher priority. Optional. Default value = 0

Fields

BatchId

The ID of the batch used in this run.
If both BatchId and BatchName are set, then BatchName is ignored.

Field Value

System.Int32

BatchName

The name of the batch used in this run.
If both BatchId and BatchName are set, then BatchName is ignored.

Field Value

System.String

BitTypeOnGridLink

Set whether to use AXIS 32- or 64-bit.

Field Value

BitTypeOnGridLink

Cores

The number of cores used.

Field Value

System.Int32

Description

The run description of the job. Max length of 255 characters.

Field Value

System.String

MaxRunTimeInMinutes

The maximum time the job can run in C4, in minutes. Using 0 means there is no max run time.
Note: ELink does not check if this time is exceeded, but C4 will cancel the job.

Field Value

System.Int32

Priority

Priority of the job. Higher values indicate higher priority.

Field Value

System.Int32

Queues

The number of queues used.

Field Value

System.Int32

StartProvisioningAfterUpload

If true, then wait until uploading is complete before provisioning a farm. Otherwise, immediately provision a farm.

Field Value

System.Boolean

Tags

Tags to use for the job.

Field Value

System.Collections.Generic.Dictionary<System.String, System.String>

Methods

ToString()

Gets useful information about the specified GlaaS batch info in a formatted string:
Batch ID, Batch Name, Cores, Queues, Maximum Run Time, Priority, StartProvisioningAfterUpload, BitTypeOnGridLink, Tags

Returns

System.String Formatted string containing the job information.

Overrides

System.Object.ToString()

Examples

Language: VB.NET

    Dim MyJob As GlaaSJob
    Dim MyDataset As New Dataset ("$WORKAREA\Test", "SAMPLE")

    MyJob = GlaaSJob.SubmitBatchToGlaaS (MyDataset.Name, App.PathLogicalToPhysical (MyDataset.Path), "Test Batch", "Test Farm", 2, 1)

    Dim JobInfo As String = MyJob.ToString ()

Language: C#

    GlaaSJob MyJob;
    Dataset MyDataset = new Dataset ("$WORKAREA\\Test", "SAMPLE");

    MyJob = GlaaSJob.SubmitBatchToGlaaS (MyDataset.Name, App.PathLogicalToPhysical (MyDataset.Path), "Test Batch", "Test Farm", 2, 1);

    string JobInfo = MyJob.ToString ();