Package com.google.cloud.tasks.v2beta2

Class Task

  • All Implemented Interfaces:
    TaskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Task
extends com.google.protobuf.GeneratedMessageV3
implements TaskOrBuilder
     A unit of scheduled work.
    Protobuf type google.cloud.tasks.v2beta2.Task
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Task.Builder
      A unit of scheduled work.
      static class  Task.PayloadTypeCase  
      static class  Task.View
      The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.

      • 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

      • getName

        public String getName()
         Optionally caller-specified in
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

 The task name.

 The task name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the task's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
 * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
   hyphens (-), or underscores (_). The maximum length is 500 characters.
        string name = 1;
        Specified by:
        getName in interface TaskOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Optionally caller-specified in
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

 The task name.

 The task name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the task's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
 * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
   hyphens (-), or underscores (_). The maximum length is 500 characters.
        string name = 1;
        Specified by:
        getNameBytes in interface TaskOrBuilder
        Returns:
        The bytes for name.

      • hasAppEngineHttpRequest

        public boolean hasAppEngineHttpRequest()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;
        Specified by:
        hasAppEngineHttpRequest in interface TaskOrBuilder
        Returns:
        Whether the appEngineHttpRequest field is set.

      • getAppEngineHttpRequest

        public AppEngineHttpRequest getAppEngineHttpRequest()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;
        Specified by:
        getAppEngineHttpRequest in interface TaskOrBuilder
        Returns:
        The appEngineHttpRequest.

      • getAppEngineHttpRequestOrBuilder

        public AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;
        Specified by:
        getAppEngineHttpRequestOrBuilder in interface TaskOrBuilder

      • hasPullMessage

        public boolean hasPullMessage()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;
        Specified by:
        hasPullMessage in interface TaskOrBuilder
        Returns:
        Whether the pullMessage field is set.

      • getPullMessage

        public PullMessage getPullMessage()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;
        Specified by:
        getPullMessage in interface TaskOrBuilder
        Returns:
        The pullMessage.

      • getPullMessageOrBuilder

        public PullMessageOrBuilder getPullMessageOrBuilder()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;
        Specified by:
        getPullMessageOrBuilder in interface TaskOrBuilder

      • hasHttpRequest

        public boolean hasHttpRequest()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;
        Specified by:
        hasHttpRequest in interface TaskOrBuilder
        Returns:
        Whether the httpRequest field is set.

      • getHttpRequest

        public HttpRequest getHttpRequest()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;
        Specified by:
        getHttpRequest in interface TaskOrBuilder
        Returns:
        The httpRequest.

      • getHttpRequestOrBuilder

        public HttpRequestOrBuilder getHttpRequestOrBuilder()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;
        Specified by:
        getHttpRequestOrBuilder in interface TaskOrBuilder

      • hasScheduleTime

        public boolean hasScheduleTime()
         The time when the task is scheduled to be attempted.

 For App Engine queues, this is when the task will be attempted or retried.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;
        Specified by:
        hasScheduleTime in interface TaskOrBuilder
        Returns:
        Whether the scheduleTime field is set.

      • getScheduleTime

        public com.google.protobuf.Timestamp getScheduleTime()
         The time when the task is scheduled to be attempted.

 For App Engine queues, this is when the task will be attempted or retried.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;
        Specified by:
        getScheduleTime in interface TaskOrBuilder
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
         The time when the task is scheduled to be attempted.

 For App Engine queues, this is when the task will be attempted or retried.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;
        Specified by:
        getScheduleTimeOrBuilder in interface TaskOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;
        Specified by:
        hasCreateTime in interface TaskOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTime in interface TaskOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTimeOrBuilder in interface TaskOrBuilder

      • hasStatus

        public boolean hasStatus()
         Output only. The task status.
        .google.cloud.tasks.v2beta2.TaskStatus status = 7;
        Specified by:
        hasStatus in interface TaskOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public TaskStatus getStatus()
         Output only. The task status.
        .google.cloud.tasks.v2beta2.TaskStatus status = 7;
        Specified by:
        getStatus in interface TaskOrBuilder
        Returns:
        The status.

      • getViewValue

        public int getViewValue()
         Output only. The view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] has been returned.
        .google.cloud.tasks.v2beta2.Task.View view = 8;
        Specified by:
        getViewValue in interface TaskOrBuilder
        Returns:
        The enum numeric value on the wire for view.

      • getView

        public Task.View getView()
         Output only. The view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] has been returned.
        .google.cloud.tasks.v2beta2.Task.View view = 8;
        Specified by:
        getView in interface TaskOrBuilder
        Returns:
        The view.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Task getDefaultInstance()

      • parser

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

      • getParserForType

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