Google Cloud PHP shared dependency, providing functionality useful to all components. Client - Class JobConfig (1.60.0)

Version latest

• 1.60.0 (latest)
• 1.59.1
• 1.58.2
• 1.53.0
• 1.52.11
• 1.51.2
• 1.50.0
• 1.49.3
• 1.48.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class JobConfig.

Hold configurations for the BatchRunner.

Namespace

Google \ Cloud \ Core \ Batch

Methods

getJobFromId

Get the job with the given identifier.

Parameter
Name	Description
identifier	string Unique identifier of the job.

Returns
Type	Description
JobInterface|null

getJobFromIdNum

Get the job with the given numeric id.

Parameter
Name	Description
idNum	int A numeric id of the job.

Returns
Type	Description
JobInterface|null

registerJob

Register a job for executing in batch.

Parameters
Name	Description
identifier	string Unique identifier of the job.
callback	callable Callback that accepts the job $idNum and returns a JobInterface instance.

Returns
Type	Description
void

getJobs

Get all the jobs indexed by the job's identifier.

Returns
Type	Description
array	Associative array of JobInterface instances keyed by a string identifier.