Package com.google.cloud.scheduler.v1beta1

Class ListJobsRequest

  • All Implemented Interfaces:
    ListJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListJobsRequestOrBuilder
     Request message for listing jobs using
 [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
    Protobuf type google.cloud.scheduler.v1beta1.ListJobsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListJobsRequest.Builder
      Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface ListJobsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListJobsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public 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;
        Specified by:
        getFilter in interface ListJobsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface ListJobsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public 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;
        Specified by:
        getPageSize in interface ListJobsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface ListJobsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface ListJobsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getLegacyAppEngineCron

        public 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;
        Specified by:
        getLegacyAppEngineCron in interface ListJobsRequestOrBuilder
        Returns:
        The legacyAppEngineCron.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListJobsRequest parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListJobsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListJobsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListJobsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListJobsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<ListJobsRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<ListJobsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListJobsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder