Reference documentation and code samples for the Cloud Scheduler V1 Client class ListJobsRequest.
Request message for listing jobs using ListJobs.
Generated from protobuf message google.cloud.scheduler.v1.ListJobsRequest
Namespace
Google \ Cloud \ Scheduler \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The location name. For example: |
↳ 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. |
getParent
Required. The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The location name. For example:
projects/PROJECT_ID/locations/LOCATION_ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The location name. For example:
|
| Returns | |
|---|---|
| Type | Description |
ListJobsRequest |
|