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 \ BatchMethods
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. |