Cloud Scheduler V1beta1 Client - Class DeleteJobRequest (1.7.1)

Reference documentation and code samples for the Cloud Scheduler V1beta1 Client class DeleteJobRequest.

Request message for deleting a job using DeleteJob.

Generated from protobuf message google.cloud.scheduler.v1beta1.DeleteJobRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

↳ 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 deleted instead.

getName

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns
TypeDescription
string

setName

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$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 deleted instead.

Returns
TypeDescription
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 deleted instead.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this