Package com.google.cloud.scheduler.v1beta1

Interface ListJobsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListJobsRequest, ListJobsRequest.Builder
    public interface ListJobsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      `filter` can be used to specify a subset of jobs.
      com.google.protobuf.ByteString getFilterBytes()
      `filter` can be used to specify a subset of jobs.
      boolean getLegacyAppEngineCron()
      This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API.
      int getPageSize()
      Requested page size.
      String getPageToken()
      A token identifying a page of results the server will return.
      com.google.protobuf.ByteString getPageTokenBytes()
      A token identifying a page of results the server will return.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The location name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The location name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        String 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 filter = 4;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         `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 filter = 4;
        Returns:
        The bytes for filter.

      • getPageSize

        int 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.
        int32 page_size = 5;
        Returns:
        The pageSize.

      • getPageToken

        String 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][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token]
 returned from the previous call to
 [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is
 an error to switch the value of
 [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
 [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
 iterating through pages.
        string page_token = 6;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         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][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token]
 returned from the previous call to
 [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is
 an error to switch the value of
 [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
 [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
 iterating through pages.
        string page_token = 6;
        Returns:
        The bytes for pageToken.

      • getLegacyAppEngineCron

        boolean 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 legacy_app_engine_cron = 7;
        Returns:
        The legacyAppEngineCron.