Class: Google::Cloud::Scheduler::V1::ListJobsRequest

Inherits:

Object

• Object
• Google::Cloud::Scheduler::V1::ListJobsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb

Overview

Request message for listing jobs using ListJobs.

Instance Attribute Summary

• #page_size ⇒ ::Integer

  Requested page size.

• #page_token ⇒ ::String

  A token identifying a page of results the server will return.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

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

# File 'proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb', line 50

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][google.cloud.scheduler.v1.ListJobsRequest.filter] or [order_by][google.cloud.scheduler.v1.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][google.cloud.scheduler.v1.ListJobsRequest.filter] or [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while iterating through pages.

# File 'proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb', line 50

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.

# File 'proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb', line 50

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