# Cloud Scheduler V1beta1 API - Class Google::Cloud::Scheduler::V1beta1::ListJobsRequest (v0.18.0)

0.18.0 (latest) 0.17.1 0.16.0 0.15.1 0.14.0 0.13.1 0.12.0 0.11.1 0.10.2 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.5 Reference documentation and code samples for the Cloud Scheduler V1beta1 API class Google::Cloud::Scheduler::V1beta1::ListJobsRequest.

Request message for listing jobs using
[ListJobs](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-CloudScheduler-Client#Google__Cloud__Scheduler__V1beta1__CloudScheduler__Client_list_jobs_instance_ "Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs (method)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

**Returns**

- (::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.

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #legacy_app_engine_cron

    def legacy_app_engine_cron() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #legacy_app_engine_cron=

    def legacy_app_engine_cron=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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.
**Returns**

- (::Boolean) --- 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.

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- 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_size=

    def page_size=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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**

- (::Integer) --- 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

    def page_token() -> ::String

**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsResponse#Google__Cloud__Scheduler__V1beta1__ListJobsResponse_next_page_token_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token (method)") returned from the previous call to [ListJobs](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-CloudScheduler-Client#Google__Cloud__Scheduler__V1beta1__CloudScheduler__Client_list_jobs_instance_ "Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs (method)"). It is an error to switch the value of [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsRequest#Google__Cloud__Scheduler__V1beta1__ListJobsRequest_filter_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsRequest#filter (method)") or \[order_by\]\[google.cloud.scheduler.v1beta1.ListJobsRequest.order_by\] while iterating through pages.

### #page_token=

    def page_token=(value) -> ::String

**Parameter**

- **value** (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsResponse#Google__Cloud__Scheduler__V1beta1__ListJobsResponse_next_page_token_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token (method)") returned from the previous call to [ListJobs](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-CloudScheduler-Client#Google__Cloud__Scheduler__V1beta1__CloudScheduler__Client_list_jobs_instance_ "Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs (method)"). It is an error to switch the value of [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsRequest#Google__Cloud__Scheduler__V1beta1__ListJobsRequest_filter_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsRequest#filter (method)") or \[order_by\]\[google.cloud.scheduler.v1beta1.ListJobsRequest.order_by\] while iterating through pages.
**Returns**

- (::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsResponse#Google__Cloud__Scheduler__V1beta1__ListJobsResponse_next_page_token_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token (method)") returned from the previous call to [ListJobs](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-CloudScheduler-Client#Google__Cloud__Scheduler__V1beta1__CloudScheduler__Client_list_jobs_instance_ "Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs (method)"). It is an error to switch the value of [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-scheduler-v1beta1/latest/Google-Cloud-Scheduler-V1beta1-ListJobsRequest#Google__Cloud__Scheduler__V1beta1__ListJobsRequest_filter_instance_ "Google::Cloud::Scheduler::V1beta1::ListJobsRequest#filter (method)") or \[order_by\]\[google.cloud.scheduler.v1beta1.ListJobsRequest.order_by\] while iterating through pages.

### #parent

    def parent() -> ::String

**Returns**

- (::String) --- Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
**Returns**

- (::String) --- Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.