Class ListJobsRequest.Builder

  • All Implemented Interfaces:
    ListJobsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListJobsRequest

    public static final class ListJobsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
    implements ListJobsRequestOrBuilder
     Request message for listing jobs using
     [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
     
    Protobuf type google.cloud.scheduler.v1beta1.ListJobsRequest
    • Method Detail

      • 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.Builder<ListJobsRequest.Builder>
      • clear

        public ListJobsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • getDefaultInstanceForType

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

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

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

        public ListJobsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • setField

        public ListJobsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • clearField

        public ListJobsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • clearOneof

        public ListJobsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • setRepeatedField

        public ListJobsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • addRepeatedField

        public ListJobsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • mergeFrom

        public ListJobsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListJobsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • mergeFrom

        public ListJobsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListJobsRequest.Builder>
        Throws:
        IOException
      • 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.
      • setParent

        public ListJobsRequest.Builder setParent​(String value)
         Required. The location name. For example:
         `projects/PROJECT_ID/locations/LOCATION_ID`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.
      • clearParent

        public ListJobsRequest.Builder clearParent()
         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:
        This builder for chaining.
      • setParentBytes

        public ListJobsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The location name. For example:
         `projects/PROJECT_ID/locations/LOCATION_ID`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.
      • 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.
      • setFilter

        public ListJobsRequest.Builder setFilter​(String value)
         `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;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.
      • clearFilter

        public ListJobsRequest.Builder clearFilter()
         `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:
        This builder for chaining.
      • setFilterBytes

        public ListJobsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         `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;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.
      • 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.
      • setPageSize

        public ListJobsRequest.Builder setPageSize​(int value)
         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;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public ListJobsRequest.Builder clearPageSize()
         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:
        This builder for chaining.
      • 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.
      • setPageToken

        public ListJobsRequest.Builder setPageToken​(String value)
         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;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public ListJobsRequest.Builder clearPageToken()
         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:
        This builder for chaining.
      • setPageTokenBytes

        public ListJobsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • 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.
      • setLegacyAppEngineCron

        public ListJobsRequest.Builder setLegacyAppEngineCron​(boolean value)
         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;
        Parameters:
        value - The legacyAppEngineCron to set.
        Returns:
        This builder for chaining.
      • clearLegacyAppEngineCron

        public ListJobsRequest.Builder clearLegacyAppEngineCron()
         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:
        This builder for chaining.
      • setUnknownFields

        public final ListJobsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>
      • mergeUnknownFields

        public final ListJobsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListJobsRequest.Builder>