SparkBulkJob

An object that represents a bulk job.

e.g.

var bulkJob = Spark.getBulkJobScheduler().listBulkJobs(null)[0];

getId

signature getId()

returns string

Returns the ID of this bulk job.

example

Spark.getBulkJobScheduler().listBulkJobs(null)[0].getId();

getActualCount

signature getActualCount()

returns number

The actual count of players affected by the bulk job

getCompleted

signature getCompleted()

returns date

The time at which the bulk job completed execution

getCreated

signature getCreated()

returns date

The time at which the bulk job was created

getData

signature getData()

returns JSON

Data to be passed into the Module or Script

getDoneCount

signature getDoneCount()

returns number

The number of players processed by the bulk job

getErrorCount

signature getErrorCount()

returns number

The number of errors encountered whilst running the Module or Script for players

getEstimatedCount

signature getEstimatedCount()

returns number

The estimated count of players affected by the bulk job

getModuleShortCode

signature getModuleShortCode()

returns string

The Cloud Code Module to run for each player

getPlayerQuery

signature getPlayerQuery()

returns JSON

The query to identify players to perform the bulk job on

getScheduledTime

signature getScheduledTime()

returns date

The time at which the job was scheduled to run

getScript

signature getScript()

returns string

The Cloud Code script to run for each player

getStarted

signature getStarted()

returns date

The time at which the bulk job started to execute

Did this page help you? Please enter your feedback below. For questions about using this part of the platform, please contact support here