publicfinalclass TaskextendsGeneratedMessageV3implementsTaskOrBuilder
A unit of scheduled work.
Protobuf type google.cloud.tasks.v2beta2.Task
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 |
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()
newBuilder()
publicstaticTask.BuildernewBuilder()
newBuilder(Task prototype)
publicstaticTask.BuildernewBuilder(Taskprototype)
| Parameter |
| Name |
Description |
prototype |
Task
|
publicstaticTaskparseDelimitedFrom(InputStreaminput)
| Returns |
| Type |
Description |
Task |
publicstaticTaskparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
parseFrom(byte[] data)
publicstaticTaskparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Task |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticTaskparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
parseFrom(ByteString data)
publicstaticTaskparseFrom(ByteStringdata)
| Returns |
| Type |
Description |
Task |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticTaskparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
publicstaticTaskparseFrom(CodedInputStreaminput)
| Returns |
| Type |
Description |
Task |
publicstaticTaskparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
publicstaticTaskparseFrom(InputStreaminput)
| Returns |
| Type |
Description |
Task |
publicstaticTaskparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
parseFrom(ByteBuffer data)
publicstaticTaskparseFrom(ByteBufferdata)
| Returns |
| Type |
Description |
Task |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticTaskparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Task |
parser()
publicstaticParser<Task>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
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;
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;
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;
getDefaultInstanceForType()
publicTaskgetDefaultInstanceForType()
| Returns |
| Type |
Description |
Task |
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()
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()
Overrides
getPayloadTypeCase()
publicTask.PayloadTypeCasegetPayloadTypeCase()
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;
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;
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;
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getStatus()
publicTaskStatusgetStatus()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
getStatusOrBuilder()
publicTaskStatusOrBuildergetStatusOrBuilder()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()
Overrides
getView()
Output only. The view specifies which subset of the Task has
been returned.
.google.cloud.tasks.v2beta2.Task.View view = 8;
getViewValue()
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.
|
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()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Returns |
| Type |
Description |
boolean |
Whether the status field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicTask.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedTask.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicTask.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides