Class: Google::Cloud::Scheduler::V1beta1::ListJobsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb

Overview

Request message for listing jobs using ListJobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.



65
66
67
68
 
# File 'proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb', line 65

class ListJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#legacy_app_engine_cron ⇒ ::Boolean

Returns 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.



65
66
67
68
 
# File 'proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb', line 65

class ListJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



65
66
67
68
 
# File 'proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb', line 65

class ListJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#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][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 returned from the previous call to ListJobs. It is an error to switch the value of filter or [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.



65
66
67
68
 
# File 'proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb', line 65

class ListJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.



65
66
67
68
 
# File 'proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb', line 65

class ListJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end