Reference documentation and code samples for the Cloud Scheduler V1beta1 Client class RunJobRequest.
Request message for forcing a job to run now using RunJob.
Generated from protobuf message google.cloud.scheduler.v1beta1.RunJobRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The job name. For example: |
↳ legacy_app_engine_cron |
bool
This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead. |
getName
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLegacyAppEngineCron
This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead.
| Returns | |
|---|---|
| Type | Description |
bool | |
setLegacyAppEngineCron
This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will be forced to run instead.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |