Package com.google.cloud.tasks.v2

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.v2.Task
    See Also:
    Serialized Form

    • Field Detail

      • APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

        public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTP_REQUEST_FIELD_NUMBER

        public static final int HTTP_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULE_TIME_FIELD_NUMBER

        public static final int SCHEDULE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPATCH_DEADLINE_FIELD_NUMBER

        public static final int DISPATCH_DEADLINE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPATCH_COUNT_FIELD_NUMBER

        public static final int DISPATCH_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_COUNT_FIELD_NUMBER

        public static final int RESPONSE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FIRST_ATTEMPT_FIELD_NUMBER

        public static final int FIRST_ATTEMPT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAST_ATTEMPT_FIELD_NUMBER

        public static final int LAST_ATTEMPT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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.v2.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.v2.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()
         HTTP request that is sent to the App Engine app handler.

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

      • getAppEngineHttpRequest

        public AppEngineHttpRequest getAppEngineHttpRequest()
         HTTP request that is sent to the App Engine app handler.

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

      • getAppEngineHttpRequestOrBuilder

        public AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()
         HTTP request that is sent to the App Engine app handler.

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

      • hasHttpRequest

        public boolean hasHttpRequest()
         HTTP request that is sent to the worker.

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

      • getHttpRequest

        public HttpRequest getHttpRequest()
         HTTP request that is sent to the worker.

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

      • getHttpRequestOrBuilder

        public HttpRequestOrBuilder getHttpRequestOrBuilder()
         HTTP request that is sent to the worker.

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

      • hasScheduleTime

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

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 4;
        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 or retried.

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 4;
        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 or retried.

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 4;
        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 = 5;
        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 = 5;
        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 = 5;
        Specified by:
        getCreateTimeOrBuilder in interface TaskOrBuilder

      • hasDispatchDeadline

        public boolean hasDispatchDeadline()
         The deadline for requests sent to the worker. If the worker does not
 respond by this deadline then the request is cancelled and the attempt
 is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
 task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].

 Note that when the request is cancelled, Cloud Tasks will stop listening
 for the response, but whether the worker stops processing depends on the
 worker. For example, if the worker is stuck, it may not react to cancelled
 requests.

 The default and maximum values depend on the type of request:

 * For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10
 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].

 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0
 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   of the service: 10 minutes for standard apps with automatic scaling, 24
   hours for standard apps with manual and basic scaling, and 60 minutes for
   flex apps. If the request deadline is set, it must be in the interval [15
   seconds, 24 hours 15 seconds]. Regardless of the task's
   `dispatch_deadline`, the app handler will not run for longer than than
   the service's timeout. We recommend setting the `dispatch_deadline` to
   at most a few seconds more than the app handler's timeout. For more
   information see
   [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).

 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
        .google.protobuf.Duration dispatch_deadline = 6;
        Specified by:
        hasDispatchDeadline in interface TaskOrBuilder
        Returns:
        Whether the dispatchDeadline field is set.

      • getDispatchDeadline

        public com.google.protobuf.Duration getDispatchDeadline()
         The deadline for requests sent to the worker. If the worker does not
 respond by this deadline then the request is cancelled and the attempt
 is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
 task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].

 Note that when the request is cancelled, Cloud Tasks will stop listening
 for the response, but whether the worker stops processing depends on the
 worker. For example, if the worker is stuck, it may not react to cancelled
 requests.

 The default and maximum values depend on the type of request:

 * For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10
 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].

 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0
 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   of the service: 10 minutes for standard apps with automatic scaling, 24
   hours for standard apps with manual and basic scaling, and 60 minutes for
   flex apps. If the request deadline is set, it must be in the interval [15
   seconds, 24 hours 15 seconds]. Regardless of the task's
   `dispatch_deadline`, the app handler will not run for longer than than
   the service's timeout. We recommend setting the `dispatch_deadline` to
   at most a few seconds more than the app handler's timeout. For more
   information see
   [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).

 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
        .google.protobuf.Duration dispatch_deadline = 6;
        Specified by:
        getDispatchDeadline in interface TaskOrBuilder
        Returns:
        The dispatchDeadline.

      • getDispatchDeadlineOrBuilder

        public com.google.protobuf.DurationOrBuilder getDispatchDeadlineOrBuilder()
         The deadline for requests sent to the worker. If the worker does not
 respond by this deadline then the request is cancelled and the attempt
 is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
 task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].

 Note that when the request is cancelled, Cloud Tasks will stop listening
 for the response, but whether the worker stops processing depends on the
 worker. For example, if the worker is stuck, it may not react to cancelled
 requests.

 The default and maximum values depend on the type of request:

 * For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10
 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].

 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0
 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   of the service: 10 minutes for standard apps with automatic scaling, 24
   hours for standard apps with manual and basic scaling, and 60 minutes for
   flex apps. If the request deadline is set, it must be in the interval [15
   seconds, 24 hours 15 seconds]. Regardless of the task's
   `dispatch_deadline`, the app handler will not run for longer than than
   the service's timeout. We recommend setting the `dispatch_deadline` to
   at most a few seconds more than the app handler's timeout. For more
   information see
   [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).

 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
        .google.protobuf.Duration dispatch_deadline = 6;
        Specified by:
        getDispatchDeadlineOrBuilder in interface TaskOrBuilder

      • getDispatchCount

        public int getDispatchCount()
         Output only. The number of attempts dispatched.

 This count includes attempts which have been dispatched but haven't
 received a response.
        int32 dispatch_count = 7;
        Specified by:
        getDispatchCount in interface TaskOrBuilder
        Returns:
        The dispatchCount.

      • getResponseCount

        public int getResponseCount()
         Output only. The number of attempts which have received a response.
        int32 response_count = 8;
        Specified by:
        getResponseCount in interface TaskOrBuilder
        Returns:
        The responseCount.

      • hasFirstAttempt

        public boolean hasFirstAttempt()
         Output only. The status of the task's first attempt.

 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be
 set. The other [Attempt][google.cloud.tasks.v2.Attempt] information is not
 retained by Cloud Tasks.
        .google.cloud.tasks.v2.Attempt first_attempt = 9;
        Specified by:
        hasFirstAttempt in interface TaskOrBuilder
        Returns:
        Whether the firstAttempt field is set.

      • getFirstAttempt

        public Attempt getFirstAttempt()
         Output only. The status of the task's first attempt.

 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be
 set. The other [Attempt][google.cloud.tasks.v2.Attempt] information is not
 retained by Cloud Tasks.
        .google.cloud.tasks.v2.Attempt first_attempt = 9;
        Specified by:
        getFirstAttempt in interface TaskOrBuilder
        Returns:
        The firstAttempt.

      • getFirstAttemptOrBuilder

        public AttemptOrBuilder getFirstAttemptOrBuilder()
         Output only. The status of the task's first attempt.

 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be
 set. The other [Attempt][google.cloud.tasks.v2.Attempt] information is not
 retained by Cloud Tasks.
        .google.cloud.tasks.v2.Attempt first_attempt = 9;
        Specified by:
        getFirstAttemptOrBuilder in interface TaskOrBuilder

      • hasLastAttempt

        public boolean hasLastAttempt()
         Output only. The status of the task's last attempt.
        .google.cloud.tasks.v2.Attempt last_attempt = 10;
        Specified by:
        hasLastAttempt in interface TaskOrBuilder
        Returns:
        Whether the lastAttempt field is set.

      • getLastAttempt

        public Attempt getLastAttempt()
         Output only. The status of the task's last attempt.
        .google.cloud.tasks.v2.Attempt last_attempt = 10;
        Specified by:
        getLastAttempt in interface TaskOrBuilder
        Returns:
        The lastAttempt.

      • getViewValue

        public int getViewValue()
         Output only. The view specifies which subset of the
 [Task][google.cloud.tasks.v2.Task] has been returned.
        .google.cloud.tasks.v2.Task.View view = 11;
        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.v2.Task] has been returned.
        .google.cloud.tasks.v2.Task.View view = 11;
        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