Class Task (2.52.0) 

public final class Task extends GeneratedMessageV3 implements TaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2.Task

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Task

Implements

TaskOrBuilder

Static Fields

APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPATCH_COUNT_FIELD_NUMBER

public static final int DISPATCH_COUNT_FIELD_NUMBER
Field Value
Type Description
int

DISPATCH_DEADLINE_FIELD_NUMBER

public static final int DISPATCH_DEADLINE_FIELD_NUMBER
Field Value
Type Description
int

FIRST_ATTEMPT_FIELD_NUMBER

public static final int FIRST_ATTEMPT_FIELD_NUMBER
Field Value
Type Description
int

HTTP_REQUEST_FIELD_NUMBER

public static final int HTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

LAST_ATTEMPT_FIELD_NUMBER

public static final int LAST_ATTEMPT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_COUNT_FIELD_NUMBER

public static final int RESPONSE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Task getDefaultInstance()
Returns
Type Description
Task

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Task.Builder newBuilder()
Returns
Type Description
Task.Builder

newBuilder(Task prototype)

public static Task.Builder newBuilder(Task prototype)
Parameter
Name Description
prototype Task
Returns
Type Description
Task.Builder

parseDelimitedFrom(InputStream input)

public static Task parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Task parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Task parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Task parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Task> parser()
Returns
Type Description
Parser<Task>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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 set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Returns
Type Description
AppEngineHttpRequest

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 set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Returns
Type Description
AppEngineHttpRequestOrBuilder

getCreateTime()

public 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;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Task getDefaultInstanceForType()
Returns
Type Description
Task

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;

Returns
Type Description
int

The dispatchCount.

getDispatchDeadline()

public 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.

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, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type 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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
Duration

The dispatchDeadline.

getDispatchDeadlineOrBuilder()

public 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.

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, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type 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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
DurationOrBuilder

getFirstAttempt()

public Attempt getFirstAttempt()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
Attempt

The firstAttempt.

getFirstAttemptOrBuilder()

public AttemptOrBuilder getFirstAttemptOrBuilder()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
AttemptOrBuilder

getHttpRequest()

public HttpRequest getHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
HttpRequest

The httpRequest.

getHttpRequestOrBuilder()

public HttpRequestOrBuilder getHttpRequestOrBuilder()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
HttpRequestOrBuilder

getLastAttempt()

public Attempt getLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
Attempt

The lastAttempt.

getLastAttemptOrBuilder()

public AttemptOrBuilder getLastAttemptOrBuilder()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
AttemptOrBuilder

getMessageTypeCase()

public Task.MessageTypeCase getMessageTypeCase()
Returns
Type Description
Task.MessageTypeCase

getName()

public String getName()

Optionally caller-specified in 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
  • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling 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;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optionally caller-specified in 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
  • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling 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;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Task> getParserForType()
Returns
Type Description
Parser<Task>
Overrides

getResponseCount()

public int getResponseCount()

Output only. The number of attempts which have received a response.

int32 response_count = 8;

Returns
Type Description
int

The responseCount.

getScheduleTime()

public 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;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeOrBuilder()

public 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;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getView()

public Task.View getView()

Output only. The view specifies which subset of the Task has been returned.

.google.cloud.tasks.v2.Task.View view = 11;

Returns
Type Description
Task.View

The view.

getViewValue()

public int getViewValue()

Output only. The view specifies which subset of the Task has been returned.

.google.cloud.tasks.v2.Task.View view = 11;

Returns
Type Description
int

The enum numeric value on the wire for view.

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 set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Returns
Type Description
boolean

Whether the appEngineHttpRequest field is set.

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;

Returns
Type Description
boolean

Whether the createTime field is set.

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.

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, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type 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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
boolean

Whether the dispatchDeadline field is set.

hasFirstAttempt()

public boolean hasFirstAttempt()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
boolean

Whether the firstAttempt field is set.

hasHttpRequest()

public boolean hasHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
boolean

Whether the httpRequest field is set.

hasLastAttempt()

public boolean hasLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
boolean

Whether the lastAttempt field is set.

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;

Returns
Type Description
boolean

Whether the scheduleTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Task.Builder newBuilderForType()
Returns
Type Description
Task.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Task.Builder toBuilder()
Returns
Type Description
Task.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException