Package com.google.cloud.tasks.v2beta2

Class LeaseTasksRequest

  • All Implemented Interfaces:
    LeaseTasksRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class LeaseTasksRequest
extends com.google.protobuf.GeneratedMessageV3
implements LeaseTasksRequestOrBuilder
     Request message for leasing tasks using
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
    Protobuf type google.cloud.tasks.v2beta2.LeaseTasksRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LeaseTasksRequest.Builder
      Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

      • 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 queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface LeaseTasksRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface LeaseTasksRequestOrBuilder
        Returns:
        The bytes for parent.

      • getMaxTasks

        public int getMaxTasks()
         The maximum number of tasks to lease.

 The system will make a best effort to return as close to as
 `max_tasks` as possible.

 The largest that `max_tasks` can be is 1000.

 The maximum total size of a [lease tasks
 response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the
 sum of all task sizes requested reaches this limit, fewer tasks than
 requested are returned.
        int32 max_tasks = 2;
        Specified by:
        getMaxTasks in interface LeaseTasksRequestOrBuilder
        Returns:
        The maxTasks.

      • hasLeaseDuration

        public boolean hasLeaseDuration()
         Required. The duration of the lease.

 Each task returned in the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will have its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the
 current time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the
 task will not be returned to another
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call before
 its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].


 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
 before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 Otherwise the task will be returned to a later
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that
 another worker can retry it.

 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
        .google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasLeaseDuration in interface LeaseTasksRequestOrBuilder
        Returns:
        Whether the leaseDuration field is set.

      • getLeaseDuration

        public com.google.protobuf.Duration getLeaseDuration()
         Required. The duration of the lease.

 Each task returned in the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will have its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the
 current time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the
 task will not be returned to another
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call before
 its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].


 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
 before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 Otherwise the task will be returned to a later
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that
 another worker can retry it.

 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
        .google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLeaseDuration in interface LeaseTasksRequestOrBuilder
        Returns:
        The leaseDuration.

      • getLeaseDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getLeaseDurationOrBuilder()
         Required. The duration of the lease.

 Each task returned in the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will have its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the
 current time plus the `lease_duration`. The task is leased until its
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the
 task will not be returned to another
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call before
 its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].


 After the worker has successfully finished the work associated
 with the task, the worker must call via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
 before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 Otherwise the task will be returned to a later
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that
 another worker can retry it.

 The maximum lease duration is 1 week.
 `lease_duration` will be truncated to the nearest second.
        .google.protobuf.Duration lease_duration = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLeaseDurationOrBuilder in interface LeaseTasksRequestOrBuilder

      • getResponseViewValue

        public int getResponseViewValue()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is
 retrieved by default because some data, such as payloads, might be
 desirable to return only when needed because of its large size or because
 of the sensitivity of data that it contains.

 Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
        .google.cloud.tasks.v2beta2.Task.View response_view = 4;
        Specified by:
        getResponseViewValue in interface LeaseTasksRequestOrBuilder
        Returns:
        The enum numeric value on the wire for responseView.

      • getResponseView

        public Task.View getResponseView()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is
 retrieved by default because some data, such as payloads, might be
 desirable to return only when needed because of its large size or because
 of the sensitivity of data that it contains.

 Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
        .google.cloud.tasks.v2beta2.Task.View response_view = 4;
        Specified by:
        getResponseView in interface LeaseTasksRequestOrBuilder
        Returns:
        The responseView.

      • getFilter

        public String getFilter()
         `filter` can be used to specify a subset of tasks to lease.

 When `filter` is set to `tag=<my-tag>` then the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only
 tasks whose [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to
 `<my-tag>`. `<my-tag>` must be less than 500 characters.

 When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
 the same tag as the task with the oldest
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be
 returned.

 Grammar Syntax:

 * `filter = "tag=" tag | "tag_function=" function`

 * `tag = string`

 * `function = "oldest_tag()"`

 The `oldest_tag()` function returns tasks which have the same tag as the
 oldest task (ordered by schedule time).

 SDK compatibility: Although the SDK allows tags to be either
 string or
 [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
 only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
 aren't UTF-8 encoded can't be used in the
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the
 task's [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed
 as empty in Cloud Tasks.
        string filter = 5;
        Specified by:
        getFilter in interface LeaseTasksRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         `filter` can be used to specify a subset of tasks to lease.

 When `filter` is set to `tag=<my-tag>` then the
 [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only
 tasks whose [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to
 `<my-tag>`. `<my-tag>` must be less than 500 characters.

 When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
 the same tag as the task with the oldest
 [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be
 returned.

 Grammar Syntax:

 * `filter = "tag=" tag | "tag_function=" function`

 * `tag = string`

 * `function = "oldest_tag()"`

 The `oldest_tag()` function returns tasks which have the same tag as the
 oldest task (ordered by schedule time).

 SDK compatibility: Although the SDK allows tags to be either
 string or
 [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
 only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
 aren't UTF-8 encoded can't be used in the
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the
 task's [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed
 as empty in Cloud Tasks.
        string filter = 5;
        Specified by:
        getFilterBytes in interface LeaseTasksRequestOrBuilder
        Returns:
        The bytes for filter.

      • 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 LeaseTasksRequest parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<LeaseTasksRequest> 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 LeaseTasksRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder