Reference documentation and code samples for the Cloud Scheduler V1beta1 Client class ListJobsRequest.
Request message for listing jobs using ListJobs .
Generated from protobuf message google.cloud.scheduler.v1beta1.ListJobsRequest
Namespace
Google \ Cloud \ Scheduler \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
.
↳ filter
string
filter
can be used to specify a subset of jobs. If filter
equals target_config="HttpConfig"
, then the http target jobs are retrieved. If filter
equals target_config="PubSubConfig"
, then the Pub/Sub target jobs are retrieved. If filter
equals labels.foo=value1 labels.foo=value2
then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.
↳ page_size
int
Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
↳ page_token
string
A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs . It is an error to switch the value of filter or order_by while iterating through pages.
↳ 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 jobs in the __cron queue will be listed instead.
getParent
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
.
string
setParent
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
.
var
string
$this
getFilter
filter
can be used to specify a subset of jobs.
If filter
equals target_config="HttpConfig"
, then the http
target jobs are retrieved. If filter
equals target_config="PubSubConfig"
, then the Pub/Sub target jobs are
retrieved. If filter
equals labels.foo=value1
labels.foo=value2
then only jobs which are labeled with
foo=value1 AND foo=value2 will be returned.
string
setFilter
filter
can be used to specify a subset of jobs.
If filter
equals target_config="HttpConfig"
, then the http
target jobs are retrieved. If filter
equals target_config="PubSubConfig"
, then the Pub/Sub target jobs are
retrieved. If filter
equals labels.foo=value1
labels.foo=value2
then only jobs which are labeled with
foo=value1 AND foo=value2 will be returned.
var
string
$this
getPageSize
Requested page size.
The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
int
setPageSize
Requested page size.
The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
var
int
$this
getPageToken
A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs . It is an error to switch the value of filter or order_by while iterating through pages.
string
setPageToken
A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs . It is an error to switch the value of filter or order_by while iterating through pages.
var
string
$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 jobs in the __cron queue will be listed instead.
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 jobs in the __cron queue will be listed instead.
var
bool
$this
