Class Task (2.72.0)

publicfinalclass TaskextendsGeneratedMessageV3implementsTaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2beta2.Task

Implements

TaskOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

publicstaticfinalintAPP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

HTTP_REQUEST_FIELD_NUMBER

publicstaticfinalintHTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

PULL_MESSAGE_FIELD_NUMBER

publicstaticfinalintPULL_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

publicstaticfinalintSCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

publicstaticfinalintSTATUS_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

publicstaticfinalintVIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticTaskgetDefaultInstance()
Returns
Type Description
Task

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticTask.BuildernewBuilder()
Returns
Type Description
Task.Builder

newBuilder(Task prototype)

publicstaticTask.BuildernewBuilder(Taskprototype)
Parameter
Name Description
prototype Task
Returns
Type Description
Task.Builder

parseDelimitedFrom(InputStream input)

publicstaticTaskparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticTaskparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticTaskparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticTaskparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticTaskparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticTaskparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticTaskparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Task>parser()
Returns
Type Description
Parser<Task>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppEngineHttpRequest()

publicAppEngineHttpRequestgetAppEngineHttpRequest()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
AppEngineHttpRequest

The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder()

publicAppEngineHttpRequestOrBuildergetAppEngineHttpRequestOrBuilder()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
AppEngineHttpRequestOrBuilder

getCreateTime()

publicTimestampgetCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

publicTaskgetDefaultInstanceForType()
Returns
Type Description
Task

getHttpRequest()

publicHttpRequestgetHttpRequest()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
HttpRequest

The httpRequest.

getHttpRequestOrBuilder()

publicHttpRequestOrBuildergetHttpRequestOrBuilder()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
HttpRequestOrBuilder

getName()

publicStringgetName()

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()

publicByteStringgetNameBytes()

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()

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

getPayloadTypeCase()

publicTask.PayloadTypeCasegetPayloadTypeCase()
Returns
Type Description
Task.PayloadTypeCase

getPullMessage()

publicPullMessagegetPullMessage()

LeaseTasks to process the task. Can be set only if pull_target is set on the queue.

A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns
Type Description
PullMessage

The pullMessage.

getPullMessageOrBuilder()

publicPullMessageOrBuildergetPullMessageOrBuilder()

LeaseTasks to process the task. Can be set only if pull_target is set on the queue.

A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns
Type Description
PullMessageOrBuilder

getScheduleTime()

publicTimestampgetScheduleTime()

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.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeOrBuilder()

publicTimestampOrBuildergetScheduleTimeOrBuilder()

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.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

publicTaskStatusgetStatus()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns
Type Description
TaskStatus

The status.

getStatusOrBuilder()

publicTaskStatusOrBuildergetStatusOrBuilder()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns
Type Description
TaskStatusOrBuilder

getView()

publicTask.ViewgetView()

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

.google.cloud.tasks.v2beta2.Task.View view = 8;

Returns
Type Description
Task.View

The view.

getViewValue()

publicintgetViewValue()

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

.google.cloud.tasks.v2beta2.Task.View view = 8;

Returns
Type Description
int

The enum numeric value on the wire for view.

hasAppEngineHttpRequest()

publicbooleanhasAppEngineHttpRequest()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
boolean

Whether the appEngineHttpRequest field is set.

hasCreateTime()

publicbooleanhasCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
boolean

Whether the createTime field is set.

hasHttpRequest()

publicbooleanhasHttpRequest()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
boolean

Whether the httpRequest field is set.

hasPullMessage()

publicbooleanhasPullMessage()

LeaseTasks to process the task. Can be set only if pull_target is set on the queue.

A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns
Type Description
boolean

Whether the pullMessage field is set.

hasScheduleTime()

publicbooleanhasScheduleTime()

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.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

Returns
Type Description
boolean

Whether the scheduleTime field is set.

hasStatus()

publicbooleanhasStatus()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicTask.BuildernewBuilderForType()
Returns
Type Description
Task.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedTask.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicTask.BuildertoBuilder()
Returns
Type Description
Task.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.