Package com.google.cloud.tasks.v2beta2

Interface PullMessageOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.ByteString getPayload()
      A data payload consumed by the worker to execute the task.
      String getTag()
      The task's tag.
      com.google.protobuf.ByteString getTagBytes()
      The task's tag.

      • 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

      • getPayload

        com.google.protobuf.ByteString getPayload()
         A data payload consumed by the worker to execute the task.
        bytes payload = 1;
        Returns:
        The payload.

      • getTag

        String getTag()
         The task's tag.

 Tags allow similar tasks to be processed in a batch. If you label
 tasks with a tag, your worker can
 [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the
 same tag using
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example,
 if you want to aggregate the events associated with a specific user once a
 day, you could tag tasks with the user ID.

 The task's tag can only be set when the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

 The tag must be less than 500 characters.

 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. If a tag isn't UTF-8
 encoded, the tag will be empty when the task is returned by Cloud Tasks.
        string tag = 2;
        Returns:
        The tag.

      • getTagBytes

        com.google.protobuf.ByteString getTagBytes()
         The task's tag.

 Tags allow similar tasks to be processed in a batch. If you label
 tasks with a tag, your worker can
 [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the
 same tag using
 [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example,
 if you want to aggregate the events associated with a specific user once a
 day, you could tag tasks with the user ID.

 The task's tag can only be set when the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

 The tag must be less than 500 characters.

 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. If a tag isn't UTF-8
 encoded, the tag will be empty when the task is returned by Cloud Tasks.
        string tag = 2;
        Returns:
        The bytes for tag.